From deffdabc302e7970c5626f4ea2776b01e2ba6634 Mon Sep 17 00:00:00 2001 From: xianny Date: Tue, 5 Nov 2019 17:06:05 -0800 Subject: [PATCH] Revert "Updated CHANGELOGS & MD docs" This reverts commit f65d8cc32529564a374fcd4674fa88493652ba0d. --- contracts/asset-proxy/CHANGELOG.json | 9 - contracts/asset-proxy/CHANGELOG.md | 6 - contracts/coordinator/CHANGELOG.json | 9 - contracts/coordinator/CHANGELOG.md | 4 - contracts/dev-utils/CHANGELOG.json | 9 - contracts/dev-utils/CHANGELOG.md | 4 - contracts/erc1155/CHANGELOG.json | 9 - contracts/erc1155/CHANGELOG.md | 5 - contracts/erc20/CHANGELOG.json | 3 +- contracts/erc20/CHANGELOG.md | 5 - contracts/erc721/CHANGELOG.json | 9 - contracts/erc721/CHANGELOG.md | 5 - contracts/exchange-forwarder/CHANGELOG.json | 3 +- contracts/exchange-forwarder/CHANGELOG.md | 4 - contracts/exchange-libs/CHANGELOG.json | 9 - contracts/exchange-libs/CHANGELOG.md | 5 - contracts/exchange/CHANGELOG.json | 9 - contracts/exchange/CHANGELOG.md | 4 - contracts/extensions/CHANGELOG.json | 9 - contracts/extensions/CHANGELOG.md | 5 - contracts/integrations/CHANGELOG.json | 9 - contracts/integrations/CHANGELOG.md | 15 - contracts/multisig/CHANGELOG.json | 9 - contracts/multisig/CHANGELOG.md | 4 - contracts/staking/CHANGELOG.json | 3 +- contracts/staking/CHANGELOG.md | 18 - contracts/test-utils/CHANGELOG.json | 9 - contracts/test-utils/CHANGELOG.md | 5 - contracts/tests/CHANGELOG.json | 9 - contracts/tests/CHANGELOG.md | 14 - contracts/utils/CHANGELOG.json | 9 - contracts/utils/CHANGELOG.md | 7 - packages/0x.js/CHANGELOG.json | 9 - packages/0x.js/CHANGELOG.md | 4 - packages/0x.js/docs/reference.mdx | 28453 +++++---- packages/abi-gen-wrappers/CHANGELOG.json | 3 +- packages/abi-gen-wrappers/CHANGELOG.md | 7 - packages/abi-gen/CHANGELOG.json | 9 - packages/abi-gen/CHANGELOG.md | 8 - packages/assert/CHANGELOG.json | 9 - packages/assert/CHANGELOG.md | 4 - packages/asset-buyer/CHANGELOG.json | 9 - packages/asset-buyer/CHANGELOG.md | 4 - packages/asset-buyer/docs/reference.mdx | 704 +- packages/asset-swapper/CHANGELOG.json | 9 - packages/asset-swapper/CHANGELOG.md | 4 - packages/asset-swapper/docs/reference.mdx | 5142 +- packages/base-contract/CHANGELOG.json | 3 +- packages/base-contract/CHANGELOG.md | 5 - packages/connect/CHANGELOG.json | 9 - packages/connect/CHANGELOG.md | 4 - packages/connect/docs/reference.mdx | 298 +- packages/contract-addresses/CHANGELOG.json | 5 +- packages/contract-addresses/CHANGELOG.md | 8 - packages/contract-artifacts/CHANGELOG.json | 9 - packages/contract-artifacts/CHANGELOG.md | 4 - packages/contract-wrappers/CHANGELOG.json | 9 - packages/contract-wrappers/CHANGELOG.md | 4 - packages/contract-wrappers/docs/reference.mdx | 51702 +++++++++------- packages/contracts-gen/CHANGELOG.json | 9 - packages/contracts-gen/CHANGELOG.md | 4 - packages/dev-utils/CHANGELOG.json | 9 - packages/dev-utils/CHANGELOG.md | 4 - packages/ethereum-types/CHANGELOG.json | 9 - packages/ethereum-types/CHANGELOG.md | 4 - packages/ethereum-types/docs/reference.mdx | 1022 +- packages/json-schemas/CHANGELOG.json | 9 - packages/json-schemas/CHANGELOG.md | 4 - packages/json-schemas/docs/reference.mdx | 8 +- packages/migrations/CHANGELOG.json | 3 +- packages/migrations/CHANGELOG.md | 4 - packages/migrations/docs/reference.mdx | 302 +- packages/order-utils/CHANGELOG.json | 3 +- packages/order-utils/CHANGELOG.md | 6 - packages/order-utils/docs/reference.mdx | 859 +- packages/orderbook/CHANGELOG.json | 9 - packages/orderbook/CHANGELOG.md | 4 - packages/sol-compiler/CHANGELOG.json | 9 - packages/sol-compiler/CHANGELOG.md | 4 - packages/sol-compiler/docs/reference.mdx | 312 +- packages/sol-coverage/CHANGELOG.json | 9 - packages/sol-coverage/CHANGELOG.md | 4 - packages/sol-coverage/docs/reference.mdx | 768 +- packages/sol-doc/CHANGELOG.json | 9 - packages/sol-doc/CHANGELOG.md | 4 - packages/sol-profiler/CHANGELOG.json | 9 - packages/sol-profiler/CHANGELOG.md | 4 - packages/sol-profiler/docs/reference.mdx | 762 +- packages/sol-resolver/CHANGELOG.json | 9 - packages/sol-resolver/CHANGELOG.md | 4 - packages/sol-trace/CHANGELOG.json | 9 - packages/sol-trace/CHANGELOG.md | 4 - packages/sol-trace/docs/reference.mdx | 778 +- packages/sol-tracing-utils/CHANGELOG.json | 9 - packages/sol-tracing-utils/CHANGELOG.md | 4 - packages/sra-spec/CHANGELOG.json | 9 - packages/sra-spec/CHANGELOG.md | 4 - packages/subproviders/CHANGELOG.json | 9 - packages/subproviders/CHANGELOG.md | 4 - packages/subproviders/docs/reference.mdx | 606 +- packages/tslint-config/CHANGELOG.json | 3 +- packages/tslint-config/CHANGELOG.md | 4 - packages/types/CHANGELOG.json | 3 +- packages/types/CHANGELOG.md | 4 - packages/typescript-typings/CHANGELOG.json | 9 - packages/typescript-typings/CHANGELOG.md | 4 - packages/utils/CHANGELOG.json | 3 +- packages/utils/CHANGELOG.md | 5 - packages/web3-wrapper/CHANGELOG.json | 9 - packages/web3-wrapper/CHANGELOG.md | 4 - packages/web3-wrapper/docs/reference.mdx | 1216 +- 111 files changed, 54515 insertions(+), 39038 deletions(-) delete mode 100644 contracts/integrations/CHANGELOG.md delete mode 100644 contracts/tests/CHANGELOG.md diff --git a/contracts/asset-proxy/CHANGELOG.json b/contracts/asset-proxy/CHANGELOG.json index d740a37ee5..c601dcce07 100644 --- a/contracts/asset-proxy/CHANGELOG.json +++ b/contracts/asset-proxy/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.3.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.3.0-beta.0", "changes": [ diff --git a/contracts/asset-proxy/CHANGELOG.md b/contracts/asset-proxy/CHANGELOG.md index 89172049f5..25bcca7ba1 100644 --- a/contracts/asset-proxy/CHANGELOG.md +++ b/contracts/asset-proxy/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.3.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.3.0-beta.0 - _October 3, 2019_ * Disallow the zero address from being made an authorized address in MixinAuthorizable, and created an archive directory that includes an old version of Ownable (#2019) @@ -17,8 +13,6 @@ CHANGELOG * Remove unused dependency on IAuthorizable in IAssetProxy (#1910) * Add `ERC20BridgeProxy` (#2220) * Add `Eth2DaiBridge` (#2221) - * Add `UniswapBridge` (#2233) - * Replaced `SafeMath` with `LibSafeMath` (#2254) ## v2.2.8 - _September 17, 2019_ diff --git a/contracts/coordinator/CHANGELOG.json b/contracts/coordinator/CHANGELOG.json index 5d29bf8d69..b3f739d5e1 100644 --- a/contracts/coordinator/CHANGELOG.json +++ b/contracts/coordinator/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.1.0-beta.0", "changes": [ diff --git a/contracts/coordinator/CHANGELOG.md b/contracts/coordinator/CHANGELOG.md index e211233f79..9ef81f5645 100644 --- a/contracts/coordinator/CHANGELOG.md +++ b/contracts/coordinator/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.1.0-beta.0 - _October 3, 2019_ * Add chainId to domain separator (#1742) diff --git a/contracts/dev-utils/CHANGELOG.json b/contracts/dev-utils/CHANGELOG.json index c7150717d5..b2bafed5a6 100644 --- a/contracts/dev-utils/CHANGELOG.json +++ b/contracts/dev-utils/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "0.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "0.1.0-beta.0", "changes": [ diff --git a/contracts/dev-utils/CHANGELOG.md b/contracts/dev-utils/CHANGELOG.md index b3b455500f..c2e84ae8ca 100644 --- a/contracts/dev-utils/CHANGELOG.md +++ b/contracts/dev-utils/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v0.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v0.1.0-beta.0 - _October 3, 2019_ * Use built in selectors instead of hard coded constants (#2055) diff --git a/contracts/erc1155/CHANGELOG.json b/contracts/erc1155/CHANGELOG.json index fbf6db48bc..f42944b3be 100644 --- a/contracts/erc1155/CHANGELOG.json +++ b/contracts/erc1155/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "1.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "1.2.0-beta.0", "changes": [ diff --git a/contracts/erc1155/CHANGELOG.md b/contracts/erc1155/CHANGELOG.md index ad65cb7975..458e81314a 100644 --- a/contracts/erc1155/CHANGELOG.md +++ b/contracts/erc1155/CHANGELOG.md @@ -5,14 +5,9 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v1.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v1.2.0-beta.0 - _October 3, 2019_ * Add `mintKnownFungibleTokensAsync()`, `isNonFungibleItemAsync()`, `isFungibleItemAsync()`, `getOwnerOfAsync()`, `getBalanceAsync()` to `Erc1155Wrapper`. (#1819) - * Replaced `SafeMath` with `LibSafeMath` (#2254) ## v1.1.15 - _September 17, 2019_ diff --git a/contracts/erc20/CHANGELOG.json b/contracts/erc20/CHANGELOG.json index 4bb045b7c7..85f06d6968 100644 --- a/contracts/erc20/CHANGELOG.json +++ b/contracts/erc20/CHANGELOG.json @@ -6,8 +6,7 @@ "note": "Create `LibERC20Token`", "pr": 2309 } - ], - "timestamp": 1573001598 + ] }, { "version": "2.3.0-beta.0", diff --git a/contracts/erc20/CHANGELOG.md b/contracts/erc20/CHANGELOG.md index aabbf1d494..66b597911c 100644 --- a/contracts/erc20/CHANGELOG.md +++ b/contracts/erc20/CHANGELOG.md @@ -5,14 +5,9 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.3.0-beta.1 - _November 6, 2019_ - - * Create `LibERC20Token` (#2309) - ## v2.3.0-beta.0 - _October 3, 2019_ * Dependencies updated - * Replaced `SafeMath` with `LibSafeMath` (#2254) ## v2.2.14 - _September 17, 2019_ diff --git a/contracts/erc721/CHANGELOG.json b/contracts/erc721/CHANGELOG.json index c9d4beb68f..4ad739fabc 100644 --- a/contracts/erc721/CHANGELOG.json +++ b/contracts/erc721/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.2.0-beta.0", "changes": [ diff --git a/contracts/erc721/CHANGELOG.md b/contracts/erc721/CHANGELOG.md index df49323189..ac1e62b0ba 100644 --- a/contracts/erc721/CHANGELOG.md +++ b/contracts/erc721/CHANGELOG.md @@ -5,14 +5,9 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.2.0-beta.0 - _October 3, 2019_ * Dependencies updated - * Replaced `SafeMath` with `LibSafeMath` (#2254) ## v2.1.15 - _September 17, 2019_ diff --git a/contracts/exchange-forwarder/CHANGELOG.json b/contracts/exchange-forwarder/CHANGELOG.json index b662d8d61f..8257cdf3ea 100644 --- a/contracts/exchange-forwarder/CHANGELOG.json +++ b/contracts/exchange-forwarder/CHANGELOG.json @@ -6,8 +6,7 @@ "note": "Use `LibERC20Token` in `MixinAssets`", "pr": 2309 } - ], - "timestamp": 1573001598 + ] }, { "version": "3.1.0-beta.0", diff --git a/contracts/exchange-forwarder/CHANGELOG.md b/contracts/exchange-forwarder/CHANGELOG.md index e1500cf630..ec731fef65 100644 --- a/contracts/exchange-forwarder/CHANGELOG.md +++ b/contracts/exchange-forwarder/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.1.0-beta.1 - _November 6, 2019_ - - * Use `LibERC20Token` in `MixinAssets` (#2309) - ## v3.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/contracts/exchange-libs/CHANGELOG.json b/contracts/exchange-libs/CHANGELOG.json index 845790343e..4059813c1e 100644 --- a/contracts/exchange-libs/CHANGELOG.json +++ b/contracts/exchange-libs/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "3.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "3.1.0-beta.0", "changes": [ diff --git a/contracts/exchange-libs/CHANGELOG.md b/contracts/exchange-libs/CHANGELOG.md index 0d10427197..80cb7c81aa 100644 --- a/contracts/exchange-libs/CHANGELOG.md +++ b/contracts/exchange-libs/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v3.1.0-beta.0 - _October 3, 2019_ * Break up `LibEIP712` into reusable components (#1742) @@ -37,7 +33,6 @@ CHANGELOG * Remove `_hashEIP712ExchangeMessage` from `LibEIP712ExchangeDomain` (#2055) * Compile and export all contracts, artifacts, and wrappers by default (#2055) * Update `IncompleteFillError` to take an `errorCode`, `expectedAssetFillAmount`, and `actualAssetFillAmount` fields. (#2075) - * Move `IWallet.sol` from `asset-proxy` and `exchange` packages to here. (#2233) ## v3.0.8 - _September 17, 2019_ diff --git a/contracts/exchange/CHANGELOG.json b/contracts/exchange/CHANGELOG.json index 0a8b529792..741ff3f973 100644 --- a/contracts/exchange/CHANGELOG.json +++ b/contracts/exchange/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.2.0-beta.0", "changes": [ diff --git a/contracts/exchange/CHANGELOG.md b/contracts/exchange/CHANGELOG.md index 6f83ddf471..7850919cf0 100644 --- a/contracts/exchange/CHANGELOG.md +++ b/contracts/exchange/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.2.0-beta.0 - _October 3, 2019_ * Use new/cheaper reentrancy guard/mutex (#1699) diff --git a/contracts/extensions/CHANGELOG.json b/contracts/extensions/CHANGELOG.json index ebefad5e22..5f12dbaa04 100644 --- a/contracts/extensions/CHANGELOG.json +++ b/contracts/extensions/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "4.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "4.1.0-beta.0", "changes": [ diff --git a/contracts/extensions/CHANGELOG.md b/contracts/extensions/CHANGELOG.md index efe3ba0afb..71ef8b1e5c 100644 --- a/contracts/extensions/CHANGELOG.md +++ b/contracts/extensions/CHANGELOG.md @@ -5,14 +5,9 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v4.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v4.1.0-beta.0 - _October 3, 2019_ * Dependencies updated - * Replaced the use of `SafeMath` with `LibSafeMath` (#2254) ## v4.0.8 - _September 17, 2019_ diff --git a/contracts/integrations/CHANGELOG.json b/contracts/integrations/CHANGELOG.json index dd4af91b08..3bc7806044 100644 --- a/contracts/integrations/CHANGELOG.json +++ b/contracts/integrations/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "1.0.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "1.0.0", "changes": [ diff --git a/contracts/integrations/CHANGELOG.md b/contracts/integrations/CHANGELOG.md deleted file mode 100644 index 7b0e7cb6da..0000000000 --- a/contracts/integrations/CHANGELOG.md +++ /dev/null @@ -1,15 +0,0 @@ - - -CHANGELOG - -## v1.0.1 - _November 6, 2019_ - - * Dependencies updated - -## v1.0.0 - _Invalid date_ - - * Created package (#2240) - * Added the deployment manager class (#2240) diff --git a/contracts/multisig/CHANGELOG.json b/contracts/multisig/CHANGELOG.json index a3024d92ef..281deebef7 100644 --- a/contracts/multisig/CHANGELOG.json +++ b/contracts/multisig/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "3.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "3.2.0-beta.0", "changes": [ diff --git a/contracts/multisig/CHANGELOG.md b/contracts/multisig/CHANGELOG.md index 873c52466e..bc562e51c2 100644 --- a/contracts/multisig/CHANGELOG.md +++ b/contracts/multisig/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v3.2.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/contracts/staking/CHANGELOG.json b/contracts/staking/CHANGELOG.json index fd34df6b71..998db9ca16 100644 --- a/contracts/staking/CHANGELOG.json +++ b/contracts/staking/CHANGELOG.json @@ -34,8 +34,7 @@ "note": "Unit tests for MixinCumulativeRewards", "pr": 2316 } - ], - "timestamp": 1573001598 + ] }, { "version": "1.1.0-beta.0", diff --git a/contracts/staking/CHANGELOG.md b/contracts/staking/CHANGELOG.md index 727f472138..09c8668a43 100644 --- a/contracts/staking/CHANGELOG.md +++ b/contracts/staking/CHANGELOG.md @@ -5,17 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v1.1.0-beta.1 - _November 6, 2019_ - - * Add more overflow safeguards to `LibFixedMath` (#2255) - * Refactored finalization state. (#2276) - * Removed protocol fee != 0 assertion. (#2278) - * Call `StakingProxy.assertValidStorageParams()` in `MixinParams.setParams()` (#2279) - * The fallback function in `StakingProxy` reverts if there is no staking contract attached (#2310) - * Fix overflow w/ `LibFixedMath._mul(-1, -2*255) (#2311) - * Unit tests for MixinScheduler (#2314) - * Unit tests for MixinCumulativeRewards (#2316) - ## v1.1.0-beta.0 - _October 3, 2019_ * Created package (#1821) @@ -35,10 +24,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 9019133586..fbac14a39b 100644 --- a/contracts/test-utils/CHANGELOG.json +++ b/contracts/test-utils/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "3.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "3.2.0-beta.0", "changes": [ diff --git a/contracts/test-utils/CHANGELOG.md b/contracts/test-utils/CHANGELOG.md index 91b389f83c..de99badf7d 100644 --- a/contracts/test-utils/CHANGELOG.md +++ b/contracts/test-utils/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v3.2.0-beta.0 - _October 3, 2019_ * Add `chainId` to `TransactionFactory` constructor (#1742) @@ -35,7 +31,6 @@ CHANGELOG * Add `hexHash()` to `hex_utils` (#2155) * Add `shortZip()` to `lang_utils.ts` (#2155) * Add `number_utils.ts` and `hexSize()` (#2220) - * Add `verifyEventsFromLogs()` (#2287) ## v3.1.16 - _September 17, 2019_ diff --git a/contracts/tests/CHANGELOG.json b/contracts/tests/CHANGELOG.json index cd7a354c0e..b4dd63c035 100644 --- a/contracts/tests/CHANGELOG.json +++ b/contracts/tests/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "timestamp": 1573001598, - "version": "0.0.2", - "changes": [ - { - "note": "Dependencies updated" - } - ] - }, { "version": "0.0.1", "changes": [ diff --git a/contracts/tests/CHANGELOG.md b/contracts/tests/CHANGELOG.md deleted file mode 100644 index d34e499d91..0000000000 --- a/contracts/tests/CHANGELOG.md +++ /dev/null @@ -1,14 +0,0 @@ - - -CHANGELOG - -## v0.0.2 - _November 6, 2019_ - - * Dependencies updated - -## v0.0.1 - _Invalid date_ - - * Created package (#2261) diff --git a/contracts/utils/CHANGELOG.json b/contracts/utils/CHANGELOG.json index 6cc57451dd..dc3f8d93a4 100644 --- a/contracts/utils/CHANGELOG.json +++ b/contracts/utils/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "3.3.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "3.3.0-beta.0", "changes": [ diff --git a/contracts/utils/CHANGELOG.md b/contracts/utils/CHANGELOG.md index a1e83e93ae..61bb5936f8 100644 --- a/contracts/utils/CHANGELOG.md +++ b/contracts/utils/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.3.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v3.3.0-beta.0 - _October 3, 2019_ * Change ReentrancyGuard implementation to cheaper one (#1699) @@ -26,9 +22,6 @@ CHANGELOG * Compile and export all contracts, artifacts, and wrappers by default (#2055) * Added LibFractions (#2118) * Introduce automatic normalization and some zero-value shortcuts in `LibFractions`. (#2155) - * Emit an event in `transferOwnership` (#2253) - * Removed `deepCopyBytes`, `popLast20Bytes`, `readBytesWithLength`, and `writeBytesWithLength` in `LibBytes`. (#2265) - * Replaced `SafeMath` with `LibSafeMath` (#2254) ## v3.2.4 - _September 17, 2019_ diff --git a/packages/0x.js/CHANGELOG.json b/packages/0x.js/CHANGELOG.json index d37ab70d69..e0e2540d12 100644 --- a/packages/0x.js/CHANGELOG.json +++ b/packages/0x.js/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "7.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "7.1.0-beta.0", "changes": [ diff --git a/packages/0x.js/CHANGELOG.md b/packages/0x.js/CHANGELOG.md index d0dd080ec4..3a42df6373 100644 --- a/packages/0x.js/CHANGELOG.md +++ b/packages/0x.js/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v7.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v7.1.0-beta.0 - _October 3, 2019_ * Updated to work with 0x v3 diff --git a/packages/0x.js/docs/reference.mdx b/packages/0x.js/docs/reference.mdx index 675bf5a334..038b1c97aa 100644 --- a/packages/0x.js/docs/reference.mdx +++ b/packages/0x.js/docs/reference.mdx @@ -1,10892 +1,3 @@ - - -# 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/44793a9cf/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 - -### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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: 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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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`* - -___ - -### `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/zrx_token.ts:834](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### balanceOf - -#### ▪ **balanceOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:580](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L580)* - -#### callAsync - -▸ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L586)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`_owner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### decimals - -#### ▪ **decimals**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:537](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L537)* - -#### 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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L543)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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`* - -___ - -### name - -#### ▪ **name**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L61)* - -#### callAsync - -▸ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L67)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/zrx_token.ts:628](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L628)* - -#### callAsync - -▸ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L634)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/zrx_token.ts:280](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L280)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:286](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L286)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/zrx_token.ts:671](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L671)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:714](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L714)* - -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 | - | - | -`_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**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:766](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.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 | ------- | ------ | ------ | -`_to` | string | - | -`_value` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:741](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L741)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | - | -`_value` | `BigNumber` | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:815](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L815)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`_to` | string | -`_value` | `BigNumber` | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L828)* - -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/zrx_token.ts:678](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L678)* - -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 | - | - | -`_value` | `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/zrx_token.ts:326](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L326)* - -ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. - -#### awaitTransactionSuccessAsync - -▸ **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/44793a9cf/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. - -**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 } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:458](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L458)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | Address to transfer from. | -`_to` | string | - | Address to transfer to. | -`_value` | `BigNumber` | - | Amount to transfer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Success of transfer. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:419](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L419)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **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/44793a9cf/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). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:531](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L531)* - -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/zrx_token.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L336)* - -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 | - | 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 - -
- -# Class: MetamaskSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) -subprovider interface and the provider sendAsync interface. -It handles inconsistencies with Metamask implementations of various JSON RPC methods. -It forwards JSON RPC requests involving the domain of a signer (getAccounts, -sendTransaction, signMessage etc...) to the provider instance supplied at instantiation. All other requests -are passed onwards for subsequent subproviders to handle. - - -## Constructors - - - -\+ **new MetamaskSubprovider**(`supportedProvider`: [SupportedProvider](#supportedprovider)): *[MetamaskSubprovider](#class-metamasksubprovider)* - -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* - -Instantiates a new MetamaskSubprovider - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider that should handle all user account related requests | - -**Returns:** *[MetamaskSubprovider](#class-metamasksubprovider)* - -## Methods - -#### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - - - -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* - -*Overrides void* - -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/metamask_subprovider.ts#L39)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### sendAsync - -▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* - -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/metamask_subprovider.ts#L117)* - -This method conforms to the provider sendAsync interface. -Allowing the MetamaskSubprovider to be used as a generic provider (outside of Web3ProviderEngine) with the -addition of wrapping the inconsistent Metamask behaviour - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`callback` | [ErrorCallback](#errorcallback) | - | - -**Returns:** *void* - -The contents nested under the result key of the response body - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - - - -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -# Class: RPCSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It forwards on JSON RPC requests to the supplied `rpcUrl` endpoint - - -## Constructors - - - -\+ **new RPCSubprovider**(`rpcUrl`: string, `requestTimeoutMs`: number): *[RPCSubprovider](#class-rpcsubprovider)* - -*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`rpcUrl` | string | - | URL to the backing Ethereum node to which JSON RPC requests should be sent | -`requestTimeoutMs` | number | 20000 | Amount of miliseconds to wait before timing out the JSON RPC request | - -**Returns:** *[RPCSubprovider](#class-rpcsubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - - - -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `_next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* - -*Overrides void* - -*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`_next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - - - -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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* - -
- -# Enumeration: ERC20TokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L38)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)* - -
- -# Enumeration: ERC721TokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L40)* - -___ - -### ApprovalForAll - -• **ApprovalForAll**: = "ApprovalForAll" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L41)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L42)* - -
- -# Enumeration: ExchangeEvents - - -## Enumeration members - -### AssetProxyRegistered - -• **AssetProxyRegistered**: = "AssetProxyRegistered" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L45)* - -___ - -### Cancel - -• **Cancel**: = "Cancel" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L46)* - -___ - -### CancelUpTo - -• **CancelUpTo**: = "CancelUpTo" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L47)* - -___ - -### Fill - -• **Fill**: = "Fill" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L48)* - -___ - -### ProtocolFeeCollectorAddress - -• **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L49)* - -___ - -### ProtocolFeeMultiplier - -• **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* - -___ - -### SignatureValidatorApproval - -• **SignatureValidatorApproval**: = "SignatureValidatorApproval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* - -___ - -### TransactionExecution - -• **TransactionExecution**: = "TransactionExecution" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)* - -
- -# Enumeration: WETH9Events - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:41](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L41)* - -___ - -### Deposit - -• **Deposit**: = "Deposit" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L43)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L42)* - -___ - -### Withdrawal - -• **Withdrawal**: = "Withdrawal" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* - -
- -# Enumeration: ZRXTokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L37)* - -
- -# Enumeration: NetworkId - - -## Enumeration members - -### Ganache - -• **Ganache**: = 50 - -*Defined in [contract-addresses/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L32)* - -___ - -### Kovan - -• **Kovan**: = 42 - -*Defined in [contract-addresses/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L31)* - -___ - -### Mainnet - -• **Mainnet**: = 1 - -*Defined in [contract-addresses/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L28)* - -___ - -### Rinkeby - -• **Rinkeby**: = 4 - -*Defined in [contract-addresses/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L30)* - -___ - -### Ropsten - -• **Ropsten**: = 3 - -*Defined in [contract-addresses/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L29)* - -
- - - -# Enumeration: BlockParamLiteral - - -## Enumeration members - -### Earliest - -• **Earliest**: = "earliest" - -*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L478)* - -___ - -### Latest - -• **Latest**: = "latest" - -*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L479)* - -___ - -### Pending - -• **Pending**: = "pending" - -*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L480)* - -
- - - - - - - - - - - -# Enumeration: AssetProxyId - - -## Enumeration members - -### ERC1155 - -• **ERC1155**: = "0xa7cb5fb7" - -*Defined in [types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L166)* - -___ - -### ERC20 - -• **ERC20**: = "0xf47261b0" - -*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L163)* - -___ - -### ERC20Bridge - -• **ERC20Bridge**: = "0xdc1600f3" - -*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L168)* - -___ - -### ERC721 - -• **ERC721**: = "0x02571792" - -*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L164)* - -___ - -### MultiAsset - -• **MultiAsset**: = "0x94cfcdd7" - -*Defined in [types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L165)* - -___ - -### StaticCall - -• **StaticCall**: = "0xc339d10a" - -*Defined in [types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L167)* - -
- - - - - - - - - - - - - -# Enumeration: SignatureType - - -## Enumeration members - -### EIP1271Wallet - -• **EIP1271Wallet**: - -*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L158)* - -___ - -### EIP712 - -• **EIP712**: - -*Defined in [types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L153)* - -___ - -### EthSign - -• **EthSign**: - -*Defined in [types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L154)* - -___ - -### Illegal - -• **Illegal**: - -*Defined in [types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L151)* - -___ - -### Invalid - -• **Invalid**: - -*Defined in [types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L152)* - -___ - -### NSignatureTypes - -• **NSignatureTypes**: - -*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L159)* - -___ - -### PreSigned - -• **PreSigned**: - -*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L157)* - -___ - -### Validator - -• **Validator**: - -*Defined in [types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L156)* - -___ - -### Wallet - -• **Wallet**: - -*Defined in [types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L155)* - -
- - - - - - - - - - - -
- -# Interface: ERC20TokenApprovalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L48)* - -___ - -### _spender - -• **_spender**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L49)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L50)* - -
- -# Interface: ERC20TokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L42)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L43)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L44)* - -
- -# Interface: ERC721TokenApprovalEventArgs - - -## Index - -### Properties - -* [_approved](#_approved) -* [_owner](#_owner) -* [_tokenId](#_tokenid) - -## Properties - -### _approved - -• **_approved**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L47)* - -___ - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L46)* - -___ - -### _tokenId - -• **_tokenId**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L48)* - -
- -# Interface: ERC721TokenApprovalForAllEventArgs - - -## Index - -### Properties - -* [_approved](#_approved) -* [_operator](#_operator) -* [_owner](#_owner) - -## Properties - -### _approved - -• **_approved**: *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L54)* - -___ - -### _operator - -• **_operator**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L53)* - -___ - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L52)* - -
- -# Interface: ERC721TokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_tokenId](#_tokenid) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L58)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L59)* - -___ - -### _tokenId - -• **_tokenId**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L60)* - -
- -# Interface: ExchangeAssetProxyRegisteredEventArgs - - -## Index - -### Properties - -* [assetProxy](#assetproxy) -* [id](#id) - -## Properties - -### assetProxy - -• **assetProxy**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L57)* - -___ - -### id - -• **id**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L56)* - -
- -# Interface: ExchangeCancelEventArgs - - -## Index - -### Properties - -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetData](#makerassetdata) -* [orderHash](#orderhash) -* [senderAddress](#senderaddress) -* [takerAssetData](#takerassetdata) - -## Properties - -### feeRecipientAddress - -• **feeRecipientAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:62](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L62)* - -___ - -### makerAddress - -• **makerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L61)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L63)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* - -___ - -### senderAddress - -• **senderAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* - -
- -# Interface: ExchangeCancelUpToEventArgs - - -## Index - -### Properties - -* [makerAddress](#makeraddress) -* [orderEpoch](#orderepoch) -* [orderSenderAddress](#ordersenderaddress) - -## Properties - -### makerAddress - -• **makerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L70)* - -___ - -### orderEpoch - -• **orderEpoch**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L72)* - -___ - -### orderSenderAddress - -• **orderSenderAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:71](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L71)* - -
- -# Interface: ExchangeFillEventArgs - - -## Index - -### Properties - -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetData](#makerassetdata) -* [makerAssetFilledAmount](#makerassetfilledamount) -* [makerFeeAssetData](#makerfeeassetdata) -* [makerFeePaid](#makerfeepaid) -* [orderHash](#orderhash) -* [protocolFeePaid](#protocolfeepaid) -* [senderAddress](#senderaddress) -* [takerAddress](#takeraddress) -* [takerAssetData](#takerassetdata) -* [takerAssetFilledAmount](#takerassetfilledamount) -* [takerFeeAssetData](#takerfeeassetdata) -* [takerFeePaid](#takerfeepaid) - -## Properties - -### feeRecipientAddress - -• **feeRecipientAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:77](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L77)* - -___ - -### makerAddress - -• **makerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:76](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L76)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L78)* - -___ - -### makerAssetFilledAmount - -• **makerAssetFilledAmount**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)* - -___ - -### makerFeeAssetData - -• **makerFeeAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* - -___ - -### makerFeePaid - -• **makerFeePaid**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)* - -___ - -### protocolFeePaid - -• **protocolFeePaid**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:89](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L89)* - -___ - -### senderAddress - -• **senderAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L84)* - -___ - -### takerAddress - -• **takerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* - -___ - -### takerAssetFilledAmount - -• **takerAssetFilledAmount**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)* - -___ - -### takerFeeAssetData - -• **takerFeeAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* - -___ - -### takerFeePaid - -• **takerFeePaid**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)* - -
- -# Interface: ExchangeProtocolFeeCollectorAddressEventArgs - - -## Index - -### Properties - -* [oldProtocolFeeCollector](#oldprotocolfeecollector) -* [updatedProtocolFeeCollector](#updatedprotocolfeecollector) - -## Properties - -### oldProtocolFeeCollector - -• **oldProtocolFeeCollector**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L93)* - -___ - -### updatedProtocolFeeCollector - -• **updatedProtocolFeeCollector**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L94)* - -
- -# Interface: ExchangeProtocolFeeMultiplierEventArgs - - -## Index - -### Properties - -* [oldProtocolFeeMultiplier](#oldprotocolfeemultiplier) -* [updatedProtocolFeeMultiplier](#updatedprotocolfeemultiplier) - -## Properties - -### oldProtocolFeeMultiplier - -• **oldProtocolFeeMultiplier**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:98](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L98)* - -___ - -### updatedProtocolFeeMultiplier - -• **updatedProtocolFeeMultiplier**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:99](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L99)* - -
- -# Interface: ExchangeSignatureValidatorApprovalEventArgs - - -## Index - -### Properties - -* [isApproved](#isapproved) -* [signerAddress](#signeraddress) -* [validatorAddress](#validatoraddress) - -## Properties - -### isApproved - -• **isApproved**: *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:105](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L105)* - -___ - -### signerAddress - -• **signerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L103)* - -___ - -### validatorAddress - -• **validatorAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L104)* - -
- -# Interface: ExchangeTransactionExecutionEventArgs - - -## Index - -### Properties - -* [transactionHash](#transactionhash) - -## Properties - -### transactionHash - -• **transactionHash**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:109](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L109)* - -
- -# Interface: WETH9ApprovalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L48)* - -___ - -### _spender - -• **_spender**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L49)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L50)* - -
- -# Interface: WETH9DepositEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L60)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L61)* - -
- -# Interface: WETH9TransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L54)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:55](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L55)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:56](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L56)* - -
- -# Interface: WETH9WithdrawalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:65](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L65)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:66](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L66)* - -
- -# Interface: ZRXTokenApprovalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L48)* - -___ - -### _spender - -• **_spender**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L49)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L50)* - -
- -# Interface: ZRXTokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L42)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L43)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L44)* - -
- -# Interface: ContractAddresses - - -## Properties - -### assetProxyOwner - -• **assetProxyOwner**: *string* - -*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L10)* - -___ - -### coordinator - -• **coordinator**: *string* - -*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L16)* - -___ - -### coordinatorRegistry - -• **coordinatorRegistry**: *string* - -*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L15)* - -___ - -### devUtils - -• **devUtils**: *string* - -*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L20)* - -___ - -### dutchAuction - -• **dutchAuction**: *string* - -*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L14)* - -___ - -### erc1155Proxy - -• **erc1155Proxy**: *string* - -*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L19)* - -___ - -### erc20BridgeProxy - -• **erc20BridgeProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L24)* - -___ - -### erc20Proxy - -• **erc20Proxy**: *string* - -*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L4)* - -___ - -### erc721Proxy - -• **erc721Proxy**: *string* - -*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L5)* - -___ - -### etherToken - -• **etherToken**: *string* - -*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L7)* - -___ - -### exchange - -• **exchange**: *string* - -*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L9)* - -___ - -### exchangeV2 - -• **exchangeV2**: *string* - -*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L8)* - -___ - -### forwarder - -• **forwarder**: *string* - -*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L12)* - -___ - -### multiAssetProxy - -• **multiAssetProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L17)* - -___ - -### orderValidator - -• **orderValidator**: *string* - -*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L13)* - -___ - -### staking - -• **staking**: *string* - -*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L22)* - -___ - -### stakingProxy - -• **stakingProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L23)* - -___ - -### staticCallProxy - -• **staticCallProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L18)* - -___ - -### zeroExGovernor - -• **zeroExGovernor**: *string* - -*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L11)* - -___ - -### zrxToken - -• **zrxToken**: *string* - -*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L6)* - -___ - -### zrxVault - -• **zrxVault**: *string* - -*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L21)* - -
- - - -# Interface: BlockRange - - -## Properties - -### fromBlock - -• **fromBlock**: *[BlockParam](#blockparam)* - -*Defined in [ethereum-types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L740)* - -___ - -### toBlock - -• **toBlock**: *[BlockParam](#blockparam)* - -*Defined in [ethereum-types/src/index.ts:741](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L741)* - -
- - - - - -# Interface: CallData - - -## Properties - -### `Optional` data - -• **data**? : *undefined | string* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* - -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* - -___ - -### `Optional` from - -• **from**? : *undefined | string* - -*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L402)* - -___ - -### `Optional` gas - -• **gas**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* - -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* - -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | number* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* - -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* - -___ - -### `Optional` to - -• **to**? : *undefined | string* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* - -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* - -___ - -### `Optional` value - -• **value**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* - -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* - -
- - - - - -# Interface: CompilerOpts - - -## Properties - -### name - -• **name**: *"solc"* - -*Defined in [ethereum-types/src/index.ts:655](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L655)* - -___ - -### settings - -• **settings**: *[CompilerSettings](#class-compilersettings)* - -*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L657)* - -___ - -### version - -• **version**: *string* - -*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L656)* - -
- -# 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/44793a9cf/packages/ethereum-types/src/index.ts#L689)* - -___ - -### `Optional` libraries - -• **libraries**? : *undefined | object* - -*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L691)* - -___ - -### `Optional` metadata - -• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* - -*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L690)* - -___ - -### `Optional` optimizer - -• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* - -*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L688)* - -___ - -### outputSelection - -• **outputSelection**: *object* - -*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L696)* - -#### 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/44793a9cf/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/44793a9cf/packages/ethereum-types/src/index.ts#L704)* - -
- -# Interface: ConstructorAbi - - -## Properties - -### inputs - -• **inputs**: *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L103)* - -___ - -### payable - -• **payable**: *boolean* - -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L104)* - -___ - -### stateMutability - -• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* - -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L105)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L102)* - -
- -# Interface: ContractArtifact - -This type defines the schema of the artifact.json file generated by Sol-compiler -schemaVersion: The version of the artifact schema -contractName: The contract name it represents -networks: Network specific information by network (address, id, constructor args, etc...) -compilerOutput: The Solidity compiler output generated from the specified compiler input -description (http://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description) -compiler: The compiler settings used -sourceCodes: The source code of the contract and all it's dependencies -sources: A mapping from source filePath to sourceMap id -sourceTreeHashHex: A unique hash generated from the contract source and that of it's dependencies. -If any of the sources change, the hash would change notifying us that a re-compilation is necessary - - -## Properties - -### compiler - -• **compiler**: *[CompilerOpts](#class-compileropts)* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* - -*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L641)* - -___ - -### compilerOutput - -• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* - -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L651)* - -___ - -### contractName - -• **contractName**: *string* - -*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L675)* - -___ - -### networks - -• **networks**: *[ContractNetworks](#class-contractnetworks)* - -*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L676)* - -___ - -### schemaVersion - -• **schemaVersion**: *string* - -*Defined in [ethereum-types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L674)* - -___ - -### sourceCodes - -• **sourceCodes**: *object* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* - -*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L647)* - -#### Type declaration: - -● \[▪ **sourceName**: *string*\]: string - -___ - -### sourceTreeHashHex - -• **sourceTreeHashHex**: *string* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* - -*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L650)* - -___ - -### sources - -• **sources**: *object* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* - -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L642)* - -#### Type declaration: - -● \[▪ **sourceName**: *string*\]: object - -
- -# Interface: ContractNetworkData - - -## Properties - -### address - -• **address**: *string* - -*Defined in [ethereum-types/src/index.ts:554](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L554)* - -___ - -Args - -• **constructorArgs**: *string* - -*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L558)* - -___ - -### links - -• **links**: *object* - -*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L555)* - -#### Type declaration: - -● \[▪ **linkName**: *string*\]: string - -
- -# Interface: ContractNetworks - - -## Hierarchy - -* **ContractVersionData** - - * [ContractArtifact](#class-contractartifact) - - -## Properties - -### compiler - -• **compiler**: *[CompilerOpts](#class-compileropts)* - -*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L641)* - -___ - -### compilerOutput - -• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* - -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L651)* - -___ - -### sourceCodes - -• **sourceCodes**: *object* - -*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L647)* - -#### Type declaration: - -● \[▪ **sourceName**: *string*\]: string - -___ - -### sourceTreeHashHex - -• **sourceTreeHashHex**: *string* - -*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L650)* - -___ - -### sources - -• **sources**: *object* - -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L642)* - -#### Type declaration: - -● \[▪ **sourceName**: *string*\]: object - -
- -# Interface: DataItem - - -## Properties - -### `Optional` components - -• **components**? : *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)* - -___ - -### name - -• **name**: *string* - -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* - -
- -# Interface: DecodedLogArgs - - -## Type parameters - -▪ **A** - - -## Properties - -### address - -• **address**: *string* - -*Inherited from [LogEntry](#interface-logentry).[address](#address)* - -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* - -___ - -### args - -• **args**: *`A`* - -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* - -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* - -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* - -___ - -### data - -• **data**: *string* - -*Inherited from [LogEntry](#interface-logentry).[data](#data)* - -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* - -___ - -### event - -• **event**: *string* - -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* - -___ - -### topics - -• **topics**: *string[]* - -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* - -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* - -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* - -
- - - -# Interface: DevdocOutput - - -## Properties - -### `Optional` author - -• **author**? : *undefined | string* - -*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L628)* - -___ - -### methods - -• **methods**: *object* - -*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L629)* - -#### Type declaration: - -● \[▪ **signature**: *string*\]: object - -___ - -### `Optional` title - -• **title**? : *undefined | string* - -*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L627)* - -
- -# Interface: EIP1193Provider - - -## Properties - -### isEIP1193 - -• **isEIP1193**: *boolean* - -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)* - -## Methods - -### on - -▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* - -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)* - -**Parameters:** - -▪ **event**: *[EIP1193Event](#eip1193event)* - -▪ **listener**: *function* - -▸ (`result`: any): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`result` | any | - -**Returns:** *this* - -___ - -### send - -▸ **send**(`method`: string, `params?`: any[]): *`Promise`* - -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)* - -**Parameters:** - -Name | Type | ------- | ------ | -`method` | string | -`params?` | any[] | - -**Returns:** *`Promise`* - -
- - - - - -# Interface: EvmBytecodeOutput - - -## Properties - -### object - -• **object**: *string* - -*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L622)* - -___ - -### sourceMap - -• **sourceMap**: *string* - -*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L623)* - -
- -# Interface: EvmOutput - - -## Properties - -### bytecode - -• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* - -*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L617)* - -___ - -### deployedBytecode - -• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* - -*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L618)* - -
- -# Interface: FallbackAbi - - -## Properties - -### payable - -• **payable**: *boolean* - -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L112)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L111)* - -
- - - -# Interface: GanacheProvider - - -## Methods - -### sendAsync - -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* - -*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L14)* - -**Parameters:** - -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | - -**Returns:** *void* - -
- - - -# Interface: JSONRPCRequestPayload - - -## Properties - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* - -___ - -### method - -• **method**: *string* - -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* - -___ - -### params - -• **params**: *any[]* - -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* - -
- -# Interface: JSONRPCResponseError - - -## Properties - -### code - -• **code**: *number* - -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* - -___ - -### message - -• **message**: *string* - -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* - -
- -# Interface: JSONRPCResponsePayload - - -## Properties - -### `Optional` error - -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* - -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* - -___ - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* - -___ - -### result - -• **result**: *any* - -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* - -
- - - - - -# Interface: LogWithDecodedArgs <**ArgsType**> - -## Type parameters - -▪ **ArgsType**: *[DecodedLogArgs](#class-decodedlogargs)* - - -## Properties - -### address - -• **address**: *string* - -*Inherited from [LogEntry](#interface-logentry).[address](#address)* - -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* - -___ - -### args - -• **args**: *`ArgsType`* - -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* - -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* - -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* - -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* - -___ - -### data - -• **data**: *string* - -*Inherited from [LogEntry](#interface-logentry).[data](#data)* - -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* - -___ - -### event - -• **event**: *string* - -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* - -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* - -___ - -### topics - -• **topics**: *string[]* - -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* - -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* - -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* - -
- -# Interface: MethodAbi - - -## Properties - -### constant - -• **constant**: *boolean* - -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L94)* - -___ - -### inputs - -• **inputs**: *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L92)* - -___ - -### name - -• **name**: *string* - -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L91)* - -___ - -### outputs - -• **outputs**: *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L93)* - -___ - -### payable - -• **payable**: *boolean* - -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L96)* - -___ - -### stateMutability - -• **stateMutability**: *[StateMutability](#statemutability)* - -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L95)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L90)* - -
- -# Interface: OptimizerSettings - - -## Properties - -### enabled - -• **enabled**: *boolean* - -*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L708)* - -___ - -### `Optional` runs - -• **runs**? : *undefined | number* - -*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L709)* - -
- - - - - -# Interface: RevertErrorAbi - - -## Properties - -### `Optional` arguments - -• **arguments**? : *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L122)* - -___ - -### name - -• **name**: *string* - -*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L121)* - -___ - -### type - -• **type**: *"error"* - -*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L120)* - -
- - - - - - - -# Interface: StandardContractOutput - - -## Properties - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - -*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L564)* - -___ - -### `Optional` devdoc - -• **devdoc**? : *[DevdocOutput](#class-devdocoutput)* - -*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L566)* - -___ - -### evm - -• **evm**: *[EvmOutput](#class-evmoutput)* - -*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L565)* - -
- - - - - - - - - - - - - - - -# Interface: TupleDataItem - - -## Properties - -### components - -• **components**: *[DataItem](#class-dataitem)[]* - -*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* - -*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L141)* - -___ - -### name - -• **name**: *string* - -*Inherited from [DataItem](#interface-dataitem).[name](#name)* - -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* - -___ - -### type - -• **type**: *string* - -*Inherited from [DataItem](#interface-dataitem).[type](#type)* - -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* - -___ - -### from - -• **from**: *string* - -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* - -___ - -### `Optional` gas - -• **gas**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* - -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* - -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | number* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* - -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* - -___ - -### `Optional` to - -• **to**? : *undefined | string* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* - -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* - -___ - -### `Optional` value - -• **value**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* - -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* - -
- -# Interface: TxDataPayable - - -## Properties - -### `Optional` data - -• **data**? : *undefined | string* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* - -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* - -___ - -### from - -• **from**: *string* - -*Inherited from [TxData](#interface-txdata).[from](#from)* - -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* - -___ - -### `Optional` gas - -• **gas**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* - -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* - -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | number* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* - -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* - -___ - -### `Optional` to - -• **to**? : *undefined | string* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* - -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* - -___ - -### `Optional` value - -• **value**? : *`BigNumber`* - -*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/44793a9cf/packages/ethereum-types/src/index.ts#L442)* - -
- -# Interface: Web3JsV1Provider - -Web3.js version 1 provider interface -This provider interface was implemented in the pre-1.0Beta releases for Web3.js. -This interface allowed sending synchonous requests, support for which was later dropped. - - -## Methods - -### send - -▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* - -*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L45)* - -**Parameters:** - -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | - -**Returns:** *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* - -___ - -### sendAsync - -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* - -*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L44)* - -**Parameters:** - -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | - -**Returns:** *void* - -
- -# Interface: Web3JsV2Provider - -Web3.js version 2 provider interface -This provider interface was used in a couple of Web3.js 1.0 beta releases -before the first attempts to conform to EIP1193 - - -## Methods - -### send - -▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* - -*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/ethereum-types/src/index.ts#L34)* - -**Returns:** *`Promise`* - -___ - -### sendAsync - -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* - -*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L35)* - -**Parameters:** - -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | - -**Returns:** *void* - -___ - -### `Optional` stop - -▸ **stop**(): *void* - -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)* - -**Returns:** *void* - -
- - - - - - - -# Interface: JSONRPCRequestPayloadWithMethod - - -## Properties - -### id - -• **id**: *number* - - - -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/44793a9cf/packages/subproviders/src/types.ts#L136)* - -___ - -### params - -• **params**: *any[]* - - - -Defined in ethereum-types/lib/index.d.ts:265 - -
- - - # Class: DevUtilsContract @@ -10898,7 +9,7 @@ Defined in ethereum-types/lib/index.d.ts:265 *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3800](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3800)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:5507](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L5507)* **Parameters:** @@ -10952,13 +63,39 @@ ___ Defined in base-contract/lib/src/index.d.ts:29 +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b506004361061025c5760003560e01c80639a7e752611610145578063cafd3a07116100bd578063d3d862d11161008c578063e4e6e7da11610071578063e4e6e7da1461063a578063e77286eb1461065b578063ee4f5a941461067d5761025c565b8063d3d862d114610605578063e25cabf7146106185761025c565b8063cafd3a071461059e578063d001c5dc146105bf578063d186037f146105d2578063d3637905146105e55761025c565b8063a6627e9f11610114578063b43cffe1116100f9578063b43cffe114610548578063bbb2dcf61461055b578063bc03f9641461057d5761025c565b8063a6627e9f14610512578063acaedc74146105255761025c565b80639a7e7526146104985780639eadc835146104bb578063a0901e51146104df578063a5cd62ba146104f25761025c565b8063459be5e2116101d85780636f83188e116101a75780637b66ad341161018c5780637b66ad34146104515780637d727512146104725780638f4ce479146104855761025c565b80636f83188e1461040d5780637914b2ec146104305761025c565b8063459be5e21461038a5780634dfdac20146103ab578063590aa875146103cb57806365129042146103eb5761025c565b80632322cf761161022f578063327d305411610214578063327d30541461033257806332aae3ad146103455780633db6dc61146103675761025c565b80632322cf76146102f0578063314853ff146103105761025c565b806302d0aec31461026157806304a5618a1461028b5780630d7b7d76146102ad578063165979e1146102ce575b600080fd5b61027461026f3660046149dd565b61069f565b6040516102829291906152e4565b60405180910390f35b61029e6102993660046149dd565b6106fb565b60405161028293929190615387565b6102c06102bb366004614565565b6107a9565b604051610282929190615292565b6102e16102dc3660046149dd565b6107cb565b604051610282939291906154c2565b6103036102fe366004614565565b610828565b6040516102829190615731565b61032361031e3660046149dd565b610850565b604051610282939291906152b9565b6102c06103403660046149dd565b610897565b6103586103533660046149dd565b6108d9565b60405161028293929190615438565b61037a6103753660046149dd565b61092c565b6040516102829493929190615258565b61039d6103983660046149dd565b610976565b6040516102829291906154ab565b6103be6103b936600461448c565b6109cc565b60405161028291906151f2565b6103de6103d936600461435d565b610a4f565b60405161028291906153e7565b6103fe6103f93660046149dd565b610ad3565b60405161028293929190614fdf565b61042061041b3660046149dd565b610b0d565b6040516102829493929190615535565b61044361043e3660046149dd565b61164e565b604051610282929190615301565b61046461045f3660046149dd565b611686565b604051610282929190614fc5565b610303610480366004614565565b6116be565b6104436104933660046149dd565b611dd3565b6104ab6104a63660046149dd565b611e63565b60405161028294939291906154f1565b6104ce6104c93660046149dd565b611ec4565b604051610282959493929190615324565b6103be6104ed3660046145d4565b611f6f565b61050561050036600461463a565b611fe8565b60405161028291906150f9565b6103de6105203660046145a9565b6120ac565b6105386105333660046149dd565b612133565b6040516102829493929190615055565b6103de6105563660046144da565b61216f565b61056e6105693660046149dd565b6121fc565b604051610282939291906153b2565b61059061058b3660046149dd565b6122a9565b6040516102829291906152a0565b6105b16105ac3660046149dd565b6122e2565b604051610282929190615528565b6103be6105cd36600461448c565b612330565b6103036105e0366004614565565b61239e565b6105f86105f3366004614a94565b6129e1565b60405161028291906154dd565b6103de6106133660046147e2565b612f7e565b61062b6106263660046146be565b612fb6565b60405161028293929190615146565b61064d61064836600461448c565b6130ee565b604051610282929190615233565b61066e610669366004614aec565b613107565b604051610282939291906156d5565b61069061068b3660046149dd565b613341565b60405161028293929190615481565b6000806106b3836106ae61337e565b6133a2565b60006106cc60048551866133fc9092919063ffffffff16565b8060200190516106df9190810190614990565b909350905060ff811660068111156106f357fe5b915050915091565b6000808061070f848263ffffffff61343f16565b92506001600160e01b031983167f02571792000000000000000000000000000000000000000000000000000000001461077d576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107749061569e565b60405180910390fd5b61078e84601063ffffffff61347316565b91506107a184602463ffffffff6134a616565b929491935050565b6000806107b684846116be565b91506107c2848461239e565b90509250929050565b60008060006107dc846106ae6134b2565b60006107f560048651876133fc9092919063ffffffff16565b8060200190516108089190810190614d20565b9094509250905060ff8116600281111561081e57fe5b9350509193909250565b600080600061083785856107a9565b9150915061084582826134d6565b925050505b92915050565b6000606080610861846106ae6134ec565b835161087790859060049063ffffffff6133fc16565b80602001905161088a9190810190614930565b9196909550909350915050565b6000806108a6836106ae613510565b82516108bc90849060049063ffffffff6133fc16565b8060200190516108cf91908101906148d2565b9094909350915050565b60008060606108ea846106ae613534565b600061090360048651876133fc9092919063ffffffff16565b8060200190516109169190810190614cd4565b9094509250905060ff8116600181111561081e57fe5b60008060608061093e856106ae613558565b845161095490869060049063ffffffff6133fc16565b806020019051610967919081019061488e565b92989197509550909350915050565b600080610985836106ae61357c565b600061099e60048551866133fc9092919063ffffffff16565b8060200190516109b19190810190614c07565b9250905060ff811660038111156109c457fe5b925050915091565b6060600082519050806040519080825280602002602001820160405280156109fe578160200160208202803883390190505b50915060005b818114610a4757610a2885858381518110610a1b57fe5b602002602001015161239e565b838281518110610a3457fe5b6020908102919091010152600101610a04565b505092915050565b6040516060907ff47261b00000000000000000000000000000000000000000000000000000000090610a85908490602401614fb1565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b0319909316929092179091529050919050565b6000806000610ae4846106ae6135a0565b8351610afa90859060049063ffffffff6133fc16565b80602001905161088a91908101906143b2565b60608080806000610b24868263ffffffff61343f16565b90506001600160e01b031981167fdedfc1f1000000000000000000000000000000000000000000000000000000001415610b95576040518060400160405280601181526020017f626174636843616e63656c4f72646572730000000000000000000000000000008152509450611124565b6001600160e01b031981167f9694a402000000000000000000000000000000000000000000000000000000001415610c04576040518060400160405280600f81526020017f626174636846696c6c4f726465727300000000000000000000000000000000008152509450611124565b6001600160e01b031981167f8ea8dfe4000000000000000000000000000000000000000000000000000000001415610c73576040518060400160405280601681526020017f626174636846696c6c4f72646572734e6f5468726f77000000000000000000008152509450611124565b6001600160e01b031981167fbeee2e14000000000000000000000000000000000000000000000000000000001415610ce2576040518060400160405280601581526020017f626174636846696c6c4f724b696c6c4f726465727300000000000000000000008152509450611124565b6001600160e01b031981167f2da62987000000000000000000000000000000000000000000000000000000001415610d51576040518060400160405280600b81526020017f63616e63656c4f726465720000000000000000000000000000000000000000008152509450611124565b6001600160e01b031981167f9b44d556000000000000000000000000000000000000000000000000000000001415610dc0576040518060400160405280600981526020017f66696c6c4f7264657200000000000000000000000000000000000000000000008152509450611124565b6001600160e01b031981167fe14b58c4000000000000000000000000000000000000000000000000000000001415610e2f576040518060400160405280600f81526020017f66696c6c4f724b696c6c4f7264657200000000000000000000000000000000008152509450611124565b6001600160e01b031981167f78d29ac1000000000000000000000000000000000000000000000000000000001415610e9e576040518060400160405280601681526020017f6d61726b65744275794f72646572734e6f5468726f77000000000000000000008152509450611124565b6001600160e01b031981167f369da099000000000000000000000000000000000000000000000000000000001415610f0d576040518060400160405280601781526020017f6d61726b657453656c6c4f72646572734e6f5468726f770000000000000000008152509450611124565b6001600160e01b031981167f8bc8efb3000000000000000000000000000000000000000000000000000000001415610f7c576040518060400160405280601981526020017f6d61726b65744275794f726465727346696c6c4f724b696c6c000000000000008152509450611124565b6001600160e01b031981167fa6c3bf33000000000000000000000000000000000000000000000000000000001415610feb576040518060400160405280601a81526020017f6d61726b657453656c6c4f726465727346696c6c4f724b696c6c0000000000008152509450611124565b6001600160e01b031981167f88ec79fb00000000000000000000000000000000000000000000000000000000141561105a576040518060400160405280600b81526020017f6d617463684f72646572730000000000000000000000000000000000000000008152509450611124565b6001600160e01b031981167f4f9559b10000000000000000000000000000000000000000000000000000000014806110bb57506001600160e01b031981167f2280c91000000000000000000000000000000000000000000000000000000000145b156110f2576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161077490615630565b6040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610774906155f9565b6001600160e01b031981167fdedfc1f10000000000000000000000000000000000000000000000000000000014156111c957855161116c90879060049063ffffffff6135c416565b80602001905161117f9190810190614607565b604080516000808252602082019092529195505b50604080516000808252602082019092529194506111c1565b60608152602001906001900390816111ac5790505b509150611646565b6001600160e01b031981167fbeee2e1400000000000000000000000000000000000000000000000000000000148061122a57506001600160e01b031981167f9694a40200000000000000000000000000000000000000000000000000000000145b8061125e57506001600160e01b031981167f8ea8dfe400000000000000000000000000000000000000000000000000000000145b156112785761126c86613644565b91955093509150611646565b6001600160e01b031981167f2da629870000000000000000000000000000000000000000000000000000000014156113605760408051600180825281830190925290816020015b6112c7613c90565b8152602001906001900390816112bf57505086519094506112f290879060049063ffffffff6135c416565b8060200190516113059190810190614a61565b8460008151811061131257fe5b602002602001018190525060006040519080825280602002602001820160405280156111935781602001602082028038833901905050604080516000808252602082019092529194506111c1565b6001600160e01b031981167fe14b58c40000000000000000000000000000000000000000000000000000000014806113c157506001600160e01b031981167f9b44d55600000000000000000000000000000000000000000000000000000000145b156113cf5761126c86613673565b6001600160e01b031981167f78d29ac100000000000000000000000000000000000000000000000000000000148061143057506001600160e01b031981167f369da09900000000000000000000000000000000000000000000000000000000145b8061146457506001600160e01b031981167f8bc8efb300000000000000000000000000000000000000000000000000000000145b8061149857506001600160e01b031981167fa6c3bf3300000000000000000000000000000000000000000000000000000000145b156114a65761126c8661376d565b6001600160e01b031981167f88ec79fb000000000000000000000000000000000000000000000000000000001415611646576114e0613c90565b6114e8613c90565b60608061150260048b518c6135c49092919063ffffffff16565b8060200190516115159190810190614b43565b604080516002808252606082019092529498509296509094509250816020015b61153d613c90565b815260200190600190039081611535579050509750838860008151811061156057fe5b6020026020010181905250828860018151811061157957fe5b602090810291909101015260408051600280825260608201909252908160200160208202803883390190505096508360a00151876000815181106115b957fe5b6020026020010181815250508260a00151876001815181106115d757fe5b60209081029190910101526040805160028082526060820190925290816020015b60608152602001906001900390816115f8579050509550818660008151811061161d57fe5b6020026020010181905250808660018151811061163657fe5b6020026020010181905250505050505b509193509193565b60008061165d836106ae6137e1565b825161167390849060049063ffffffff6133fc16565b8060200190516108cf91908101906149b4565b600080611695836106ae613805565b82516116ab90849060049063ffffffff6133fc16565b8060200190516108cf9190810190614379565b6000806116d1838263ffffffff61343f16565b90506001600160e01b031981167ff47261b000000000000000000000000000000000000000000000000000000000141561184657600061171884601063ffffffff61347316565b6040519091506060907f70a082310000000000000000000000000000000000000000000000000000000090611751908890602401614fb1565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060836001600160a01b0316836040516117cc9190614f95565b600060405180830381855afa9150503d8060008114611807576040519150601f19603f3d011682016040523d82523d6000602084013e61180c565b606091505b509150915081801561181f575080516020145b61182a57600061183b565b61183b81600063ffffffff6134a616565b955050505050611dcc565b6001600160e01b031981167f025717920000000000000000000000000000000000000000000000000000000014156119e157600080611884856106fb565b6040519194509250606091507f6352211e00000000000000000000000000000000000000000000000000000000906118c0908490602401615731565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060846001600160a01b03168360405161193b9190614f95565b600060405180830381855afa9150503d8060008114611976576040519150601f19603f3d011682016040523d82523d6000602084013e61197b565b606091505b50915091506000828015611990575081516020145b61199b5760006119ac565b6119ac82600c63ffffffff61347316565b9050896001600160a01b0316816001600160a01b0316146119ce5760006119d1565b60015b60ff169750505050505050611dcc565b6001600160e01b031981167fa7cb5fb7000000000000000000000000000000000000000000000000000000001415611bc4576000606080611a2186611ec4565b5081519296509094509250905060005b818114611bba5783516060907efdd58e00000000000000000000000000000000000000000000000000000000908b90879085908110611a6c57fe5b6020026020010151604051602401611a85929190615089565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060876001600160a01b031683604051611b009190614f95565b600060405180830381855afa9150503d8060008114611b3b576040519150601f19603f3d011682016040523d82523d6000602084013e611b40565b606091505b50915091506000828015611b55575081516020145b611b60576000611b71565b611b7182600063ffffffff6134a616565b90506000878681518110611b8157fe5b60200260200101518281611b9157fe5b0490508b811080611ba057508b155b15611ba957809b505b505060019093019250611a31915050565b5050505050611dcc565b6001600160e01b031981167fc339d10a000000000000000000000000000000000000000000000000000000001415611d15576040516060907fa85e59e40000000000000000000000000000000000000000000000000000000090611c33908690600090819081906024016153fa565b60408051601f198184030181529181526020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b03199094169390931790925260045491519092506000916001600160a01b031690611c9a908490614f95565b600060405180830381855afa9150503d8060008114611cd5576040519150601f19603f3d011682016040523d82523d6000602084013e611cda565b606091505b5050905080611cea576000611d0c565b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff5b93505050611dcc565b6001600160e01b031981167f94cfcdd7000000000000000000000000000000000000000000000000000000001415611dcc57606080611d53856121fc565b80519194509250905060005b818114611dc7576000611d8589858481518110611d7857fe5b60200260200101516116be565b90506000858381518110611d9557fe5b60200260200101518281611da557fe5b04905087811080611db4575087155b15611dbd578097505b5050600101611d5f565b505050505b5092915050565b600080611de6838263ffffffff61343f16565b91506001600160e01b031982167ff47261b00000000000000000000000000000000000000000000000000000000014611e4b576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107749061569e565b611e5c83601063ffffffff61347316565b9050915091565b60008060006060611e76856106ae613829565b6000611e8f60048751886133fc9092919063ffffffff16565b806020019051611ea29190810190614c76565b91965094509250905060ff81166006811115611eba57fe5b9450509193509193565b60008060608080611edb868563ffffffff61343f16565b94506001600160e01b031985167fa7cb5fb70000000000000000000000000000000000000000000000000000000014611f40576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107749061569e565b505050506024828101516044840151606485015160848601519496929591820184019490820184019391010190565b6060808251604051908082528060200260200182016040528015611f9d578160200160208202803883390190505b50905060005b83518114611dcc57838181518110611fb757fe5b60200260200101516001600160a01b031631828281518110611fd557fe5b6020908102919091010152600101611fa3565b60606000845190508060405190808252806020026020018201604052801561201a578160200160208202803883390190505b50915060005b8181146120a25761206b86828151811061203657fe5b602002602001015186838151811061204a57fe5b602002602001015186848151811061205e57fe5b60200260200101516129e1565b83828151811061207757fe5b6020026020010190600481111561208a57fe5b9081600481111561209757fe5b905250600101612020565b50505b9392505050565b6040516060907f0257179200000000000000000000000000000000000000000000000000000000906120e49085908590602401615089565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b031990931692909217909152905092915050565b60006060806060612146856106ae61384d565b845161215c90869060049063ffffffff6133fc16565b80602001905161096791908101906143f4565b6040516060907fa7cb5fb700000000000000000000000000000000000000000000000000000000906121ab908790879087908790602401615003565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b0319909316929092179091529050949350505050565b6000606080612211848463ffffffff61343f16565b92506001600160e01b031983167f94cfcdd70000000000000000000000000000000000000000000000000000000014612276576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107749061569e565b835161228c90859060049063ffffffff6135c416565b80602001905161229f9190810190614817565b9395909450915050565b600060606122b9836106ae613871565b82516122cf90849060049063ffffffff6133fc16565b8060200190516108cf91908101906148f5565b6000806122f1836106ae613895565b600061230a60048551866133fc9092919063ffffffff16565b80602001905161231d9190810190614c07565b9250905060ff811660018111156109c457fe5b606060008251905080604051908082528060200260200182016040528015612362578160200160208202803883390190505b50915060005b818114610a475761237f85858381518110611d7857fe5b83828151811061238b57fe5b6020908102919091010152600101612368565b6000806123b1838263ffffffff61343f16565b90506001600160e01b031981167f94cfcdd7000000000000000000000000000000000000000000000000000000001415612463576060806123f1856121fc565b80519194509250905060005b81811461245857600061241689858481518110610a1b57fe5b9050600085838151811061242657fe5b6020026020010151828161243657fe5b04905087811080612445575087155b1561244e578097505b50506001016123fd565b5061084a9350505050565b6001600160e01b031981167ff47261b00000000000000000000000000000000000000000000000000000000014156124ee5760006124a884601063ffffffff61347316565b6001546040519192506060917fdd62ed3e00000000000000000000000000000000000000000000000000000000916117519189916001600160a01b031690602401614fc5565b6001600160e01b031981167f025717920000000000000000000000000000000000000000000000000000000014156127de5760008061252c856106fb565b600254604051929550909350606092507fe985e9c50000000000000000000000000000000000000000000000000000000091612578918a916001600160a01b0390911690602401614fc5565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060846001600160a01b0316836040516125f39190614f95565b600060405180830381855afa9150503d806000811461262e576040519150601f19603f3d011682016040523d82523d6000602084013e612633565b606091505b509150915081158061264757508051602014155b80612663575061265e81600063ffffffff6134a616565b600114155b156127b1576040516060907f081812fc000000000000000000000000000000000000000000000000000000009061269e908790602401615731565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050509050856001600160a01b0316816040516127159190614f95565b600060405180830381855afa9150503d8060008114612750576040519150601f19603f3d011682016040523d82523d6000602084013e612755565b606091505b509093509150828015612769575081516020145b801561279857506002546001600160a01b031661278d83600c63ffffffff61347316565b6001600160a01b0316145b6127a35760006127a6565b60015b60ff16975050611bba565b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff96505050505050611dcc565b6001600160e01b031981167fa7cb5fb700000000000000000000000000000000000000000000000000000000141561298657600061281b84611ec4565b5050600354604051929450606093507fe985e9c50000000000000000000000000000000000000000000000000000000092612865925089916001600160a01b031690602401614fc5565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060836001600160a01b0316836040516128e09190614f95565b600060405180830381855afa9150503d806000811461291b576040519150601f19603f3d011682016040523d82523d6000602084013e612920565b606091505b5091509150818015612933575080516020145b801561294f575061294b81600063ffffffff6134a616565b6001145b61295a57600061183b565b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff955050505050611dcc565b6001600160e01b031981167fc339d10a000000000000000000000000000000000000000000000000000000001415611dcc57507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff9392505050565b60006129eb613d23565b612a7c8584600560009054906101000a90046001600160a01b03166001600160a01b0316631ce4c78b6040518163ffffffff1660e01b815260040160206040518083038186803b158015612a3e57600080fd5b505afa158015612a52573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250612a769190810190614bef565b3a6138b9565b60408051600480825260a0820190925291925060609190816020015b6060815260200190600190039081612a9857505060408051600480825260a082019092529192506060919060208201608080388339505060408051600480825260a08201909252929350606092915060208201608080388339505060408051600480825260a0820190925292935060609291506020820160808038833901905050905088610160015184600081518110612b2e57fe5b60200260200101819052508783600081518110612b4757fe5b60200260200101906001600160a01b031690816001600160a01b031681525050886000015182600081518110612b7957fe5b60200260200101906001600160a01b031690816001600160a01b0316815250508681600081518110612ba757fe5b60200260200101818152505088610140015184600181518110612bc657fe5b6020026020010181905250886000015183600181518110612be357fe5b60200260200101906001600160a01b031690816001600160a01b0316815250508782600181518110612c1157fe5b60200260200101906001600160a01b031690816001600160a01b031681525050846000015181600181518110612c4357fe5b602002602001018181525050886101a0015184600281518110612c6257fe5b60200260200101819052508783600281518110612c7b57fe5b60200260200101906001600160a01b031690816001600160a01b031681525050886040015182600281518110612cad57fe5b60200260200101906001600160a01b031690816001600160a01b031681525050846060015181600281518110612cdf57fe5b60200260200101818152505088610180015184600381518110612cfe57fe5b6020026020010181905250886000015183600381518110612d1b57fe5b60200260200101906001600160a01b031690816001600160a01b031681525050886040015182600381518110612d4d57fe5b60200260200101906001600160a01b031690816001600160a01b031681525050846040015181600381518110612d7f57fe5b60209081029190910101526040516060907fb04fbddd0000000000000000000000000000000000000000000000000000000090612dc69087908790879087906024016150a2565b60408051601f198184030181529181526020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b03199094169390931790925260055491519092506060916001600160a01b031690612e2d908490614f95565b6000604051808303816000865af19150503d8060008114612e6a576040519150601f19603f3d011682016040523d82523d6000602084013e612e6f565b606091505b50915060009050612e86828263ffffffff61343f16565b9050612e90613534565b6001600160e01b031982811691161415612ed2576000612eaf836108d9565b5091505060ff81166004811115612ec257fe5b99505050505050505050506120a5565b612eda6134ec565b6001600160e01b031982811691161415612f0d576000612ef983610850565b509091505060ff81166004811115612ec257fe5b815160208301207ff43f26ea5a94b478394a975e856464913dc1a8a1ca70939d974aa7c238aa0ce01415612f4c576004985050505050505050506120a5565b6040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610774906155c2565b6040516060907f94cfcdd700000000000000000000000000000000000000000000000000000000906120e49085908590602401615205565b606080606060008551905080604051908082528060200260200182016040528015612ffb57816020015b612fe8613d52565b815260200190600190039081612fe05790505b50935080604051908082528060200260200182016040528015613028578160200160208202803883390190505b50925080604051908082528060200260200182016040528015613055578160200160208202803883390190505b50915060005b8181146130e55761309287828151811061307157fe5b602002602001015187838151811061308557fe5b6020026020010151613107565b87518890859081106130a057fe5b602002602001018785815181106130b357fe5b602002602001018786815181106130c657fe5b931515602094850291909101909301929092529190525260010161305b565b50509250925092565b6060806130fb8484612330565b91506107c284846109cc565b61310f613d52565b600080546040517f9d3fa4b900000000000000000000000000000000000000000000000000000000815282916001600160a01b031690639d3fa4b9906131599088906004016156f9565b60606040518083038186803b15801561317157600080fd5b505afa158015613185573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052506131a99190810190614a10565b85516000546040517fa12dcc6f00000000000000000000000000000000000000000000000000000000815292955090916001600160a01b039091169063a12dcc6f906131fb908990899060040161570c565b60206040518083038186803b15801561321357600080fd5b505afa158015613227573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525061324b919081019061486e565b9150600061325e82886101400151610828565b60a088015160c08901516101808a01516101408b01519394509192909160009161328d9163ffffffff61393016565b156132ba576132b3846132ad848d6080015161395590919063ffffffff16565b85613971565b9050613313565b816132ce576132b3848b6080015185613971565b60006132df868c6101800151610828565b905060006132f2868d6080015187613971565b90506000613301838688613971565b905061330d82826134d6565b93505050505b61333361332d89604001518561399b90919063ffffffff16565b826134d6565b965050505050509250925092565b6000806000613352846106ae6139ba565b600061336b60048651876133fc9092919063ffffffff16565b8060200190516108089190810190614c34565b7ffdb6ca8d0000000000000000000000000000000000000000000000000000000090565b60006133af83600061343f565b90506001600160e01b0319808216908316146133f7576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161077490615667565b505050565b60608183111561341a5761341a613415600085856139de565b613a4d565b83518211156134335761343361341560018487516139de565b50819003910190815290565b600081600401835110156134605761346061341560038551856004016139de565b5001602001516001600160e01b03191690565b600081601401835110156134945761349461341560048551856014016139de565b5001601401516001600160a01b031690565b60006120a58383613a55565b7f18e4b1410000000000000000000000000000000000000000000000000000000090565b60008183106134e557816120a5565b5090919050565b7f4678472b0000000000000000000000000000000000000000000000000000000090565b7fb6555d6f0000000000000000000000000000000000000000000000000000000090565b7f488219a60000000000000000000000000000000000000000000000000000000090565b7f1b8388f70000000000000000000000000000000000000000000000000000000090565b7fe94a7ed00000000000000000000000000000000000000000000000000000000090565b7f4ad312750000000000000000000000000000000000000000000000000000000090565b6060818311156135dd576135dd613415600085856139de565b83518211156135f6576135f661341560018487516139de565b8282036040519080825280601f01601f191660200182016040528015613623576020820181803883390190505b5090506120a561363282613a7f565b8461363c87613a7f565b018351613a85565b606080606061366060048551866135c49092919063ffffffff16565b80602001905161088a9190810190614715565b60408051600180825281830190925260609182918291816020015b613696613c90565b81526020019060019003908161368e5750506040805160018082528183019092529194506020808301908038833901905050604080516001808252818301909252919350816020015b60608152602001906001900390816136df575050845190915061370c90859060049063ffffffff6135c416565b80602001905161371f9190810190614b9c565b8560008151811061372c57fe5b602002602001018560008151811061374057fe5b602002602001018560008151811061375457fe5b6020908102919091010192909252919052529193909250565b6040805160018082528183019092526060918291829160208083019080388339505085519193506137a99186915060049063ffffffff6135c416565b8060200190516137bc919081019061478f565b845185906000906137c957fe5b60209081029190910101919091529095929450925050565b7f11c7b7200000000000000000000000000000000000000000000000000000000090565b7fa15c0d060000000000000000000000000000000000000000000000000000000090565b7f7e5a23180000000000000000000000000000000000000000000000000000000090565b7f5bd0428d0000000000000000000000000000000000000000000000000000000090565b7f20d11f610000000000000000000000000000000000000000000000000000000090565b7ff59851840000000000000000000000000000000000000000000000000000000090565b6138c1613d23565b6020810184905260a085015160808601516138dd918691613b2a565b815260a085015160c08601516138f4918691613b2a565b604082015260a085015160e086015161390e918691613b2a565b6060820152613923828463ffffffff613b5e16565b6080820152949350505050565b6000815183511480156120a55750508051602091820120825192909101919091201490565b6000828201838110156120a5576120a561341560008686613b8b565b600061399383613987868563ffffffff613b5e16565b9063ffffffff613baa16565b949350505050565b6000828211156139b4576139b461341560028585613b8b565b50900390565b7fe53c76c80000000000000000000000000000000000000000000000000000000090565b6060632800659560e01b8484846040516024016139fd939291906154cf565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b03199093169290921790915290509392505050565b805160208201fd5b60008160200183511015613a7657613a7661341560058551856020016139de565b50016020015190565b60200190565b6020811015613aaf576001816020036101000a0380198351168185511680821786525050506133f7565b82821415613abc576133f7565b82821115613af65760208103905080820181840181515b82851015613aee578451865260209586019590940193613ad3565b9052506133f7565b60208103905080820181840183515b81861215613b215782518252601f199283019290910190613b05565b85525050505050565b6000613b37848484613bd4565b15613b4a57613b4a613415858585613c3a565b61399383613987868563ffffffff613b5e16565b600082613b6d5750600061084a565b82820282848281613b7a57fe5b04146120a5576120a5613415600186865b606063e946c1bb60e01b8484846040516024016139fd93929190615460565b600081613bc057613bc061341560038585613b8b565b6000828481613bcb57fe5b04949350505050565b600082613be657613be6613415613c59565b811580613bf1575083155b15613bfe575060006120a5565b60008380613c0857fe5b8584099050613c1d858463ffffffff613b5e16565b613c2f826103e863ffffffff613b5e16565b101595945050505050565b606063339f3de260e01b8484846040516024016139fd9392919061573a565b60408051808201909152600481527fa791837c00000000000000000000000000000000000000000000000000000000602082015290565b604051806101c0016040528060006001600160a01b0316815260200160006001600160a01b0316815260200160006001600160a01b0316815260200160006001600160a01b03168152602001600081526020016000815260200160008152602001600081526020016000815260200160008152602001606081526020016060815260200160608152602001606081525090565b6040518060a0016040528060008152602001600081526020016000815260200160008152602001600081525090565b604080516060810182526000808252602082018190529181019190915290565b803561084a81615816565b805161084a81615816565b600082601f830112613d98578081fd5b8135613dab613da682615777565b615750565b818152915060208083019084810181840286018201871015613dcc57600080fd5b60005b84811015611dc7578135613de281615816565b84529282019290820190600101613dcf565b600082601f830112613e04578081fd5b8151613e12613da682615777565b8181529150602080830190840160005b83811015613e4f57613e3a8760208451890101614074565b83526020928301929190910190600101613e22565b5050505092915050565b600082601f830112613e69578081fd5b8135613e77613da682615777565b8181529150602080830190840160005b83811015613e4f57613e9f8760208435890101614026565b83526020928301929190910190600101613e87565b600082601f830112613ec4578081fd5b8151613ed2613da682615777565b8181529150602080830190840160005b83811015613e4f57613efa8760208451890101614209565b83526020928301929190910190600101613ee2565b600082601f830112613f1f578081fd5b8135613f2d613da682615777565b8181529150602080830190840160005b83811015613e4f57613f5587602084358901016140ba565b83526020928301929190910190600101613f3d565b600082601f830112613f7a578081fd5b8151613f88613da682615777565b818152915060208083019084810181840286018201871015613fa957600080fd5b60005b84811015611dc757815184529282019290820190600101613fac565b600082601f830112613fd8578081fd5b8135613fe6613da682615777565b81815291506020808301908481018184028601820187101561400757600080fd5b60005b84811015611dc75781358452928201929082019060010161400a565b600082601f830112614036578081fd5b8135614044613da682615797565b915080825283602082850101111561405b57600080fd5b8060208401602084013760009082016020015292915050565b600082601f830112614084578081fd5b8151614092613da682615797565b91508082528360208285010111156140a957600080fd5b611dcc8160208401602086016157bb565b60006101c08083850312156140cd578182fd5b6140d681615750565b9150506140e38383613d72565b81526140f28360208401613d72565b60208201526141048360408401613d72565b60408201526141168360608401613d72565b60608201526080820135608082015260a082013560a082015260c082013560c082015260e082013560e08201526101008083013581830152506101208083013581830152506101408083013567ffffffffffffffff8082111561417857600080fd5b61418486838701614026565b838501526101609250828501359150808211156141a057600080fd5b6141ac86838701614026565b838501526101809250828501359150808211156141c857600080fd5b6141d486838701614026565b838501526101a09250828501359150808211156141f057600080fd5b506141fd85828601614026565b82840152505092915050565b60006101c080838503121561421c578182fd5b61422581615750565b9150506142328383613d7d565b81526142418360208401613d7d565b60208201526142538360408401613d7d565b60408201526142658360608401613d7d565b60608201526080820151608082015260a082015160a082015260c082015160c082015260e082015160e08201526101008083015181830152506101208083015181830152506101408083015167ffffffffffffffff808211156142c757600080fd5b6142d386838701614074565b838501526101609250828501519150808211156142ef57600080fd5b6142fb86838701614074565b8385015261018092508285015191508082111561431757600080fd5b61432386838701614074565b838501526101a092508285015191508082111561433f57600080fd5b506141fd85828601614074565b805160ff8116811461084a57600080fd5b60006020828403121561436e578081fd5b81356120a581615816565b6000806040838503121561438b578081fd5b825161439681615816565b60208401519092506143a781615816565b809150509250929050565b6000806000606084860312156143c6578081fd5b83516143d181615816565b60208501519093506143e281615816565b80925050604084015190509250925092565b60008060008060808587031215614409578182fd5b845161441481615816565b602086015190945067ffffffffffffffff80821115614431578384fd5b61443d88838901614074565b94506040870151915080821115614452578384fd5b61445e88838901614074565b93506060870151915080821115614473578283fd5b5061448087828801614074565b91505092959194509250565b6000806040838503121561449e578182fd5b82356144a981615816565b9150602083013567ffffffffffffffff8111156144c4578182fd5b6144d085828601613e59565b9150509250929050565b600080600080608085870312156144ef578182fd5b84356144fa81615816565b9350602085013567ffffffffffffffff80821115614516578384fd5b61452288838901613fc8565b94506040870135915080821115614537578384fd5b61454388838901613fc8565b93506060870135915080821115614558578283fd5b5061448087828801614026565b60008060408385031215614577578182fd5b823561458281615816565b9150602083013567ffffffffffffffff81111561459d578182fd5b6144d085828601614026565b600080604083850312156145bb578182fd5b82356145c681615816565b946020939093013593505050565b6000602082840312156145e5578081fd5b813567ffffffffffffffff8111156145fb578182fd5b61399384828501613d88565b600060208284031215614618578081fd5b815167ffffffffffffffff81111561462e578182fd5b61399384828501613eb4565b60008060006060848603121561464e578081fd5b833567ffffffffffffffff80821115614665578283fd5b61467187838801613f0f565b94506020860135915080821115614686578283fd5b61469287838801613d88565b935060408601359150808211156146a7578283fd5b506146b486828701613fc8565b9150509250925092565b600080604083850312156146d0578182fd5b823567ffffffffffffffff808211156146e7578384fd5b6146f386838701613f0f565b93506020850135915080821115614708578283fd5b506144d085828601613e59565b600080600060608486031215614729578081fd5b835167ffffffffffffffff80821115614740578283fd5b61474c87838801613eb4565b94506020860151915080821115614761578283fd5b61476d87838801613f6a565b93506040860151915080821115614782578283fd5b506146b486828701613df4565b6000806000606084860312156147a3578081fd5b835167ffffffffffffffff808211156147ba578283fd5b6147c687838801613eb4565b9450602086015193506040860151915080821115614782578283fd5b600080604083850312156147f4578182fd5b823567ffffffffffffffff8082111561480b578384fd5b6146f386838701613fc8565b60008060408385031215614829578182fd5b825167ffffffffffffffff80821115614840578384fd5b61484c86838701613f6a565b93506020850151915080821115614861578283fd5b506144d085828601613df4565b60006020828403121561487f578081fd5b815180151581146120a5578182fd5b600080600080608085870312156148a3578182fd5b8451935060208501516148b581615816565b604086015190935067ffffffffffffffff80821115614452578384fd5b600080604083850312156148e4578182fd5b505080516020909101519092909150565b60008060408385031215614907578182fd5b82519150602083015167ffffffffffffffff811115614924578182fd5b6144d085828601614074565b600080600060608486031215614944578081fd5b83519250602084015167ffffffffffffffff80821115614962578283fd5b61496e87838801614074565b93506040860151915080821115614983578283fd5b506146b486828701614074565b600080604083850312156149a2578182fd5b8251915060208301516143a78161582b565b600080604083850312156149c6578182fd5b82516001600160e01b031981168114614396578283fd5b6000602082840312156149ee578081fd5b813567ffffffffffffffff811115614a04578182fd5b61399384828501614026565b60006060828403128015614a22578182fd5b8015614a2c578182fd5b50614a376060615750565b8251614a428161582b565b8152602083810151908201526040928301519281019290925250919050565b600060208284031215614a72578081fd5b815167ffffffffffffffff811115614a88578182fd5b61399384828501614209565b600080600060608486031215614aa8578081fd5b833567ffffffffffffffff811115614abe578182fd5b614aca868287016140ba565b9350506020840135614adb81615816565b929592945050506040919091013590565b60008060408385031215614afe578182fd5b823567ffffffffffffffff80821115614b15578384fd5b614b21868387016140ba565b93506020850135915080821115614b36578283fd5b506144d085828601614026565b60008060008060808587031215614b58578182fd5b845167ffffffffffffffff80821115614b6f578384fd5b614b7b88838901614209565b95506020870151915080821115614b90578384fd5b61443d88838901614209565b600080600060608486031215614bb0578081fd5b835167ffffffffffffffff80821115614bc7578283fd5b614bd387838801614209565b9450602086015193506040860151915080821115614983578283fd5b600060208284031215614c00578081fd5b5051919050565b60008060408385031215614c19578182fd5b8251614c248161582b565b6020939093015192949293505050565b600080600060608486031215614c48578081fd5b8351614c538161582b565b602085015160408601519194509250614c6b81615816565b809150509250925092565b60008060008060808587031215614c8b578182fd5b614c95868661434c565b9350602085015192506040850151614cac81615816565b606086015190925067ffffffffffffffff811115614cc8578182fd5b61448087828801614074565b600080600060608486031215614ce8578081fd5b614cf2858561434c565b925060208401519150604084015167ffffffffffffffff811115614d14578182fd5b6146b486828701614074565b600080600060608486031215614d34578081fd5b614d3e858561434c565b925060208401519150604084015190509250925092565b1515815260200190565b6000614d6b8383614e78565b505060600190565b6001600160a01b03169052565b6000815180845260208401935060208301825b82811015614dba5781516001600160a01b0316865260209586019590910190600101614d93565b5093949350505050565b600081518084526020840180819550602083028101915060208501845b84811015614e0f578284038852614df9848351614e4c565b6020988901989094509190910190600101614de1565b50919695505050505050565b6000815180845260208401935060208301825b82811015614dba578151865260209586019590910190600101614e2e565b60008151808452614e648160208601602086016157bb565b601f01601f19169290920160200192915050565b805160ff16825260208082015190830152604090810151910152565b60006101c0614ea4848451614d73565b6020830151614eb66020860182614d73565b506040830151614ec96040860182614d73565b506060830151614edc6060860182614d73565b506080830151608085015260a083015160a085015260c083015160c085015260e083015160e0850152610100808401518186015250610120808401518186015250610140808401518282870152614f3583870182614e4c565b91505061016091508184015185820383870152614f528282614e4c565b925050506101808084015185830382870152614f6e8382614e4c565b9150506101a091508184015185820383870152614f8b8282614e4c565b9695505050505050565b60008251614fa78184602087016157bb565b9190910192915050565b6001600160a01b0391909116815260200190565b6001600160a01b0392831681529116602082015260400190565b6001600160a01b039384168152919092166020820152604081019190915260600190565b60006001600160a01b0386168252608060208301526150256080830186614e1b565b82810360408401526150378186614e1b565b83810360608501526150498186614e4c565b98975050505050505050565b60006001600160a01b0386168252608060208301526150776080830186614e4c565b82810360408401526150378186614e4c565b6001600160a01b03929092168252602082015260400190565b6000608082526150b56080830187614dc4565b82810360208401526150c78187614d80565b83810360408501526150d98187614d80565b91505082810360608401526150ee8185614e1b565b979650505050505050565b602080825282518282018190526000918401906040840190835b8181101561513b5783516005811061512757fe5b835260209384019390920191600101615113565b509095945050505050565b6000606082016060835280865161515d8184615731565b9150602088019250835b8181101561518b5761517a838551614d5f565b602094909401939250600101615167565b5050838103602085015261519f8187614e1b565b91505082810360408401528084516151b78184615731565b9150602086019250835b818110156151e5576151d4838551614d55565b6020949094019392506001016151c1565b5090979650505050505050565b6000602082526120a56020830184614e1b565b6000604082526152186040830185614e1b565b828103602084015261522a8185614dc4565b95945050505050565b6000604082526152466040830185614e1b565b828103602084015261522a8185614e1b565b60008582526001600160a01b0385166020830152608060408301526152806080830185614e4c565b82810360608401526150ee8185614e4c565b918252602082015260400190565b6000838252604060208301526139936040830184614e4c565b6000848252606060208301526152d26060830185614e4c565b8281036040840152614f8b8185614e4c565b828152604081016152f48361580c565b8260208301529392505050565b6001600160e01b03199290921682526001600160a01b0316602082015260400190565b60006001600160e01b0319871682526001600160a01b038616602083015260a0604083015261535660a0830186614e1b565b82810360608401526153688186614e1b565b838103608085015261537a8186614e4c565b9998505050505050505050565b6001600160e01b03199390931683526001600160a01b03919091166020830152604082015260600190565b60006001600160e01b031985168252606060208301526153d56060830185614e1b565b8281036040840152614f8b8185614dc4565b6000602082526120a56020830184614e4c565b60006080825261540d6080830187614e4c565b6001600160a01b03958616602084015293909416604082015260ff9190911660609091015292915050565b6000615443856157eb565b8482528360208301526060604083015261522a6060830184614e4c565b6060810161546d856157f8565b938152602081019290925260409091015290565b6060810161548e85615802565b93815260208101929092526001600160a01b031660409091015290565b604081016154b8846157f8565b9281526020015290565b6060810161546d85615802565b606081016008851061546d57fe5b60208101600583106154eb57fe5b91905290565b60006154fc8661580c565b8582528460208301526001600160a01b038416604083015260806060830152614f8b6080830184614e4c565b604081016154b8846157eb565b6000608082526155486080830187614e4c565b602083820381850152818751808452828401915082838202850101838a01865b8381101561559657601f19878403018552615584838351614e94565b94860194925090850190600101615568565b505086810360408801526155aa818a614e1b565b94505050505082810360608401526150ee8185614dc4565b60208082526013908201527f554e4b4e4f574e5f52455455524e5f4441544100000000000000000000000000604082015260600190565b60208082526019908201527f554e4b4e4f574e5f46554e4354494f4e5f53454c4543544f5200000000000000604082015260600190565b6020808252600d908201527f554e494d504c454d454e54454400000000000000000000000000000000000000604082015260600190565b6020808252600c908201527f4241445f53454c4543544f520000000000000000000000000000000000000000604082015260600190565b6020808252600e908201527f57524f4e475f50524f58595f4944000000000000000000000000000000000000604082015260600190565b60a081016156e38286614e78565b8360608301528215156080830152949350505050565b6000602082526120a56020830184614e94565b60006040825261571f6040830185614e94565b828103602084015261522a8185614e4c565b90815260200190565b9283526020830191909152604082015260600190565b60405181810167ffffffffffffffff8111828210171561576f57600080fd5b604052919050565b600067ffffffffffffffff82111561578d578081fd5b5060209081020190565b600067ffffffffffffffff8211156157ad578081fd5b50601f01601f191660200190565b60005b838110156157d65781810151838201526020016157be565b838111156157e5576000848401525b50505050565b600281106157f557fe5b50565b600481106157f557fe5b600381106157f557fe5b600781106157f557fe5b6001600160a01b03811681146157f557600080fd5b60ff811681146157f557600080fdfea365627a7a723158200ea049525ebc74d73f3bf7858c601bd21168267b0dfb4abbdb7787cfd7233a2c6c6578706572696d656e74616cf564736f6c634300050c0040" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L31)* + ## Methods +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2534](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2534)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4241](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4241)* **Returns:** *[ContractAbi](#contractabi)* @@ -10970,7 +107,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2487](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2487)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4194)* **Parameters:** @@ -10991,7 +128,7 @@ ___ ▸ **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:2454](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2454)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4161](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4161)* **Parameters:** @@ -11030,7 +167,7 @@ Name | Type | #### ▪ **decodeAssetProxyDispatchError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L45)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L36)* Decompose an ABI-encoded AssetProxyDispatchError. @@ -11038,7 +175,7 @@ Decompose an ABI-encoded AssetProxyDispatchError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L53)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L44)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11056,13 +193,69 @@ Name | Type | Default | Description | errorCode The error code.orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:109](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L109)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:97](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L97)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L84)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeAssetProxyExistsError #### ▪ **decodeAssetProxyExistsError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L90)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L120)* Decompose an ABI-encoded AssetProxyExistsError. @@ -11070,7 +263,7 @@ Decompose an ABI-encoded AssetProxyExistsError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L98)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L128)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11088,13 +281,69 @@ Name | Type | Default | Description | assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:193](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L193)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L181)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L168)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeAssetProxyTransferError #### ▪ **decodeAssetProxyTransferError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L135)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:204](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L204)* Decompose an ABI-encoded AssetProxyTransferError. @@ -11102,7 +351,7 @@ Decompose an ABI-encoded AssetProxyTransferError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:143](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L143)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L212)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11120,13 +369,69 @@ Name | Type | Default | Description | orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched.errorData ABI-encoded revert data from the asset proxy. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:277](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L277)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:265](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L265)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:252](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L252)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeEIP1271SignatureError #### ▪ **decodeEIP1271SignatureError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:180](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L180)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:288](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L288)* Decompose an ABI-encoded SignatureValidatorError. @@ -11134,7 +439,7 @@ Decompose an ABI-encoded SignatureValidatorError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:188](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L188)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:296](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L296)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11152,13 +457,69 @@ Name | Type | Default | Description | signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:361](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L361)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L349)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L336)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeERC1155AssetData #### ▪ **decodeERC1155AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:225](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L225)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:374](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L374)* Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. @@ -11166,7 +527,7 @@ Decode ERC-1155 asset data from the format described in the AssetProxy contract ▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:234](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L234)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:383](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L383)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11184,13 +545,69 @@ Name | Type | Default | Description | The ERC-1155 AssetProxy identifier, the address of the ERC-1155 contract hosting the assets, an array of the identifiers of the assets to be traded, an array of asset amounts to be traded, and callback data. Each element of the arrays corresponds to the same-indexed element of the other array. Return values specified as `memory` are returned as pointers to locations within the memory of the input parameter `assetData`. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`[], `BigNumber`[], string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L449)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, `BigNumber`[], `BigNumber`[], string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:437](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L437)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:426](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L426)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeERC20AssetData #### ▪ **decodeERC20AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:273](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L273)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:462](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L462)* Decode ERC-20 asset data from the format described in the AssetProxy contract specification. @@ -11198,7 +615,7 @@ Decode ERC-20 asset data from the format described in the AssetProxy contract sp ▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:281](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L281)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:470](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L470)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11216,13 +633,69 @@ Name | Type | Default | Description | The ERC-20 AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:533](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L533)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:521](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L521)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:510](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L510)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-20 asset. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeERC721AssetData #### ▪ **decodeERC721AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:318](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L318)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:544](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L544)* Decode ERC-721 asset data from the format described in the AssetProxy contract specification. @@ -11230,7 +703,7 @@ Decode ERC-721 asset data from the format described in the AssetProxy contract s ▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:327](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L327)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:553](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -11248,13 +721,69 @@ Name | Type | Default | Description | The ERC-721 AssetProxy identifier, the address of the ERC-721 contract hosting this asset, and the identifier of the specific asset to be traded. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L617)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:605](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L605)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:594](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L594)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-721 asset. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeExchangeInvalidContextError #### ▪ **decodeExchangeInvalidContextError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:364](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L364)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L628)* Decompose an ABI-encoded OrderStatusError. @@ -11262,7 +791,7 @@ Decompose an ABI-encoded OrderStatusError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:372](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L372)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:636](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L636)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11280,13 +809,69 @@ Name | Type | Default | Description | errorCode Error code that corresponds to invalid maker, taker, or sender.orderHash The order hash.contextAddress The maker, taker, or sender address +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:701](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L701)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L689)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L676)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeFillError #### ▪ **decodeFillError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:409](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L409)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:712](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L712)* Decompose an ABI-encoded FillError. @@ -11294,7 +879,7 @@ Decompose an ABI-encoded FillError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L417)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:720](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L720)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11312,13 +897,69 @@ Name | Type | Default | Description | errorCode The error code.orderHash The order hash. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:783](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L783)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:771](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L771)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:760](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L760)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeIncompleteFillError #### ▪ **decodeIncompleteFillError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:454](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L454)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:794](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L794)* Decompose an ABI-encoded IncompleteFillError. @@ -11326,7 +967,7 @@ Decompose an ABI-encoded IncompleteFillError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, BigNumber, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:462](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L462)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:802](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L802)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11344,13 +985,69 @@ Name | Type | Default | Description | orderHash Hash of the order being filled. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, `BigNumber`, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:867](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L867)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, `BigNumber`, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:855](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L855)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:842](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L842)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeMultiAssetData #### ▪ **decodeMultiAssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:499](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L499)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:878](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L878)* Decode multi-asset data from the format described in the AssetProxy contract specification. @@ -11358,7 +1055,7 @@ Decode multi-asset data from the format described in the AssetProxy contract spe ▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, BigNumber[], string[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:507](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L507)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:886](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L886)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11376,13 +1073,69 @@ Name | Type | Default | Description | The Multi-Asset AssetProxy identifier, an array of the amounts of the assets to be traded, and an array of the AssetProxy-compliant data describing each asset to be traded. Each element of the arrays corresponds to the same-indexed element of the other array. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, `BigNumber`[], string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:949](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L949)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, `BigNumber`[], string[]]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:937](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L937)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:926](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L926)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant data describing a multi-asset basket. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeNegativeSpreadError #### ▪ **decodeNegativeSpreadError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:544](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L544)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:962](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L962)* Decompose an ABI-encoded NegativeSpreadError. @@ -11390,7 +1143,7 @@ Decompose an ABI-encoded NegativeSpreadError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:552](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L552)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:970](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L970)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11408,13 +1161,69 @@ Name | Type | Default | Description | leftOrderHash Hash of the left order being matched.rightOrderHash Hash of the right order being matched. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1035](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1035)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1023](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1023)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1010](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1010)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeOrderEpochError #### ▪ **decodeOrderEpochError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:589](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L589)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1046](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1046)* Decompose an ABI-encoded OrderEpochError. @@ -11422,7 +1231,7 @@ Decompose an ABI-encoded OrderEpochError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:597](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L597)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1054](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1054)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11440,13 +1249,69 @@ Name | Type | Default | Description | makerAddress The order maker.orderSenderAddress The order sender.currentEpoch The current epoch for the maker. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1117)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1105)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1094](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1094)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeOrderStatusError #### ▪ **decodeOrderStatusError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:634](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L634)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1128)* Decompose an ABI-encoded OrderStatusError. @@ -11454,7 +1319,7 @@ Decompose an ABI-encoded OrderStatusError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, number]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:642](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L642)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1136)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11472,13 +1337,69 @@ Name | Type | Default | Description | orderHash The order hash.orderStatus The order status. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, number]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1199](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1199)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, number]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1187](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1187)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1176](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1176)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeSignatureError #### ▪ **decodeSignatureError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:679](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L679)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1210](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1210)* Decompose an ABI-encoded SignatureError. @@ -11486,7 +1407,7 @@ Decompose an ABI-encoded SignatureError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:687](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L687)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1218](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1218)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11504,13 +1425,69 @@ Name | Type | Default | Description | errorCode The error code.signerAddress The expected signer of the hash.signature The full signature. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1281](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1281)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1269](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1269)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1258](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1258)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeSignatureValidatorNotApprovedError #### ▪ **decodeSignatureValidatorNotApprovedError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:724](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L724)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1294](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1294)* Decompose an ABI-encoded SignatureValidatorNotApprovedError. @@ -11518,7 +1495,7 @@ Decompose an ABI-encoded SignatureValidatorNotApprovedError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:732](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L732)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1302](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1302)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11536,13 +1513,69 @@ Name | Type | Default | Description | signerAddress The expected signer of the hash.validatorAddress The expected validator. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1370](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1370)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1358)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1344](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeSignatureWalletError #### ▪ **decodeSignatureWalletError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:771](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L771)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1381](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1381)* Decompose an ABI-encoded SignatureWalletError. @@ -11550,7 +1583,7 @@ Decompose an ABI-encoded SignatureWalletError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:779](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L779)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1389)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11568,13 +1601,69 @@ Name | Type | Default | Description | 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. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1454](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1454)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1442)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1429)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeTransactionError #### ▪ **decodeTransactionError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:816](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L816)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1467](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1467)* Decompose an ABI-encoded TransactionError. @@ -11582,7 +1671,7 @@ Decompose an ABI-encoded TransactionError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:824](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L824)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1475](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1475)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11600,13 +1689,69 @@ Name | Type | Default | Description | errorCode The error code.transactionHash Hash of the transaction. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1538](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1538)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1526](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1526)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1515](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1515)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeTransactionExecutionError #### ▪ **decodeTransactionExecutionError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:861](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L861)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1549](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1549)* Decompose an ABI-encoded TransactionExecutionError. @@ -11614,7 +1759,7 @@ Decompose an ABI-encoded TransactionExecutionError. ▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:869](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L869)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1557](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1557)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11632,13 +1777,69 @@ Name | Type | Default | Description | transactionHash Hash of the transaction.errorData Error thrown by exeucteTransaction(). +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1622)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1610](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1610)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1597](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1597)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeZeroExTransactionData #### ▪ **decodeZeroExTransactionData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:906](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L906)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1633](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1633)* Decodes the call data for an Exchange contract method call. @@ -11646,7 +1847,7 @@ Decodes the call data for an Exchange contract method call. ▸ **callAsync**(`transactionData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, Array, BigNumber[], string[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:915](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L915)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1642](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1642)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11664,13 +1865,69 @@ Name | Type | Default | Description | The name of the function called, and the parameters it was given. For single-order fills and cancels, the arrays will have just one element. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, `Array`, `BigNumber`[], string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1752](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1752)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, `Array`, `BigNumber`[], string[]]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1740](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1740)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1727](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1727)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionData` | string | ABI-encoded calldata for an Exchange contract method call. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### encodeERC1155AssetData #### ▪ **encodeERC1155AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:996](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L996)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1807](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1807)* Encode ERC-1155 asset data into the format described in the AssetProxy contract specification. @@ -11678,7 +1935,7 @@ Encode ERC-1155 asset data into the format described in the AssetProxy contract ▸ **callAsync**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1009](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1009)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1820](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1820)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11699,13 +1956,72 @@ Name | Type | Default | Description | AssetProxy-compliant asset data describing the set of assets. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1908](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1908)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1896](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1896)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1874](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1874)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | The address of the ERC-1155 contract hosting the asset(s) to be traded. | +`tokenIds` | `BigNumber`[] | The identifiers of the specific assets to be traded. | +`tokenValues` | `BigNumber`[] | The amounts of each asset to be traded. | +`callbackData` | string | Data to be passed to receiving contracts when a transfer is performed. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### encodeERC20AssetData #### ▪ **encodeERC20AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1055](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1055)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1919](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1919)* Encode ERC-20 asset data into the format described in the AssetProxy contract specification. @@ -11713,7 +2029,7 @@ Encode ERC-20 asset data into the format described in the AssetProxy contract sp ▸ **callAsync**(`tokenAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1064](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1064)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1928](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1928)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11731,13 +2047,69 @@ Name | Type | Default | Description | AssetProxy-compliant data describing the asset. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1996](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1996)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1984](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1984)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1971](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1971)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | The address of the ERC-20 contract hosting the asset to be traded. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### encodeERC721AssetData #### ▪ **encodeERC721AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1103)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2007](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2007)* Encode ERC-721 asset data into the format described in the AssetProxy specification. @@ -11745,7 +2117,7 @@ Encode ERC-721 asset data into the format described in the AssetProxy specificat ▸ **callAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1113](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1113)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2017](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2017)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11764,13 +2136,70 @@ Name | Type | Default | Description | AssetProxy-compliant asset data describing the asset. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2091](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2091)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2079](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2079)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2064](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2064)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | The address of the ERC-721 contract hosting the asset to be traded. | +`tokenId` | `BigNumber` | The identifier of the specific asset to be traded. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### encodeMultiAssetData #### ▪ **encodeMultiAssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1155](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1155)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2102)* Encode data for multiple assets, per the AssetProxy contract specification. @@ -11778,7 +2207,7 @@ Encode data for multiple assets, per the AssetProxy contract specification. ▸ **callAsync**(`amounts`: `BigNumber`[], `nestedAssetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1165](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1165)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2112)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11797,13 +2226,70 @@ Name | Type | Default | Description | AssetProxy-compliant data describing the set of assets. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2186)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2174](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2174)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`[]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2159)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`amounts` | `BigNumber`[] | The amounts of each asset to be traded. | +`nestedAssetData` | string[] | AssetProxy-compliant data describing each asset to be traded. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getAssetProxyAllowance #### ▪ **getAssetProxyAllowance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1207](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1207)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2197)* 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. @@ -11811,7 +2297,7 @@ Returns the number of asset(s) (described by assetData) that the corresponding A ▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1217](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1217)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2207](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2207)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11830,13 +2316,70 @@ Name | Type | Default | Description | Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2289)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2277](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2277)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2262](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2262)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getBalance #### ▪ **getBalance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1267](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1267)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2300](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2300)* 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. @@ -11844,7 +2387,7 @@ Returns the owner's balance of the assets(s) specified in assetData. When the a ▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1277](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1277)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2310](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2310)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11863,13 +2406,70 @@ Name | Type | Default | Description | Number of assets (or asset baskets) held by owner. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2392)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2380](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2380)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2365](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2365)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getBalanceAndAssetProxyAllowance #### ▪ **getBalanceAndAssetProxyAllowance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1327](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1327)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2403](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2403)* Calls getBalance() and getAllowance() for assetData. @@ -11877,7 +2477,7 @@ Calls getBalance() and getAllowance() for assetData. ▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1337](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1337)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2413](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2413)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11896,13 +2496,70 @@ Name | Type | Default | Description | Number of assets (or asset baskets) held by owner, and number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2495](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2495)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`BigNumber`, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2483)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2468)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getBatchAssetProxyAllowances #### ▪ **getBatchAssetProxyAllowances**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1387](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1387)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2506](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2506)* Calls getAssetProxyAllowance() for each element of assetData. @@ -11910,7 +2567,7 @@ Calls getAssetProxyAllowance() for each element of assetData. ▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1397](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1397)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2516](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2516)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11929,13 +2586,70 @@ Name | Type | Default | Description | An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2598](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2598)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2586](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2586)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2571](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2571)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getBatchBalances #### ▪ **getBatchBalances**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1447](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1447)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2609](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2609)* Calls getBalance() for each element of assetData. @@ -11943,7 +2657,7 @@ Calls getBalance() for each element of assetData. ▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1457](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1457)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2619](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2619)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11962,13 +2676,70 @@ Name | Type | Default | Description | Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2701](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2701)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2689)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2674)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getBatchBalancesAndAssetProxyAllowances #### ▪ **getBatchBalancesAndAssetProxyAllowances**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1507](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1507)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2712](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2712)* Calls getBatchBalances() and getBatchAllowances() for each element of assetData. @@ -11976,7 +2747,7 @@ Calls getBatchBalances() and getBatchAllowances() for each element of assetData. ▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1517](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1517)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2722](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2722)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -11995,13 +2766,70 @@ Name | Type | Default | Description | An array of asset balances from getBalance(), and an array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`[], `BigNumber`[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2804](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2804)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`BigNumber`[], `BigNumber`[]]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2792](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2792)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2777](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2777)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getEthBalances #### ▪ **getEthBalances**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1567](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1567)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2815](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2815)* Batch fetches ETH balances @@ -12009,7 +2837,7 @@ Batch fetches ETH balances ▸ **callAsync**(`addresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1575](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1575)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2823](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2823)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -12027,13 +2855,69 @@ Name | Type | Default | Description | Array of ETH balances. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2894](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2894)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2882](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2882)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string[]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`addresses`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2871](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2871)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`addresses` | string[] | Array of addresses. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getOrderRelevantState #### ▪ **getOrderRelevantState**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1620](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1620)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2905](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2905)* Fetches all order-relevant information needed to validate if the supplied order is fillable. @@ -12041,7 +2925,7 @@ Fetches all order-relevant information needed to validate if the supplied order ▸ **callAsync**(`order`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, BigNumber, boolean]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1631](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1631)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2916](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2916)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -12060,13 +2944,70 @@ Name | Type | Default | Description | The orderInfo (hash, status, and `takerAssetAmount` already filled for the given order), fillableTakerAssetAmount (amount of the order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (validity of the provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, `fillableTakerAssetAmount` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[object, `BigNumber`, boolean]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3078](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3078)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[object, `BigNumber`, boolean]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3024](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3024)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[object, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2992](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2992)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The order structure. | +`signature` | string | Signature provided by maker that proves the order's authenticity. `0x01` can always be provided if the signature does not need to be validated. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getOrderRelevantStates #### ▪ **getOrderRelevantStates**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1701](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1701)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3095](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3095)* Fetches all order-relevant information needed to validate if the supplied orders are fillable. @@ -12074,7 +3015,7 @@ Fetches all order-relevant information needed to validate if the supplied orders ▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, BigNumber[], boolean[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1712](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1712)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3106](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3106)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -12093,34 +3034,92 @@ Name | Type | Default | Description | The ordersInfo (array of the hash, status, and `takerAssetAmount` already filled for each order), fillableTakerAssetAmounts (array of amounts for each order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (array containing the validity of each provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, each element of `fillableTakerAssetAmounts` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`Array`, `BigNumber`[], boolean[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3278](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3278)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`Array`, `BigNumber`[], boolean[]]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3224](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3224)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`Array`, string[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3191](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3191)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order structures. | +`signatures` | string[] | Array of signatures provided by makers that prove the authenticity of the orders. `0x01` can always be provided if a signature does not need to be validated. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getSimulatedOrderTransferResults #### ▪ **getSimulatedOrderTransferResults**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1791](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1791)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3303](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3303)* Simulates all of the transfers within an order and returns the index of the first failed transfer. #### awaitTransactionSuccessAsync -▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1866](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1866)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3368](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3368)* 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 } | - | +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` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* @@ -12130,7 +3129,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1972](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1972)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3509](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3509)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -12154,7 +3153,7 @@ The index of the first failed transfer (or 4 if all transfers are successful). ▸ **estimateGasAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1919](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1919)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3421](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3421)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. @@ -12171,11 +3170,47 @@ Name | Type | Description | The hash of the transaction +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3663](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3663)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *number* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3617)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2046](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2046)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3583](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3583)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used @@ -12193,67 +3228,74 @@ Name | Type | Description | The ABI encoded transaction data as a string -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2078](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2078)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - #### sendTransactionAsync -▸ **sendTransactionAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +▸ **sendTransactionAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1802](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1802)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3314](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3314)* 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 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 } | - | +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 +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3464](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3464)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAddress` | string | +`takerAssetFillAmount` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + ___ ### getSimulatedOrdersTransferResults #### ▪ **getSimulatedOrdersTransferResults**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2089](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2089)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3676)* Simulates all of the transfers for each given order and returns the indices of each first failed transfer. #### awaitTransactionSuccessAsync -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2167](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2167)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3744](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3744)* 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 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 | +------ | ------ | ------ | +`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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* @@ -12263,7 +3305,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2277](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2277)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3889](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3889)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -12287,7 +3329,7 @@ The indices of the first failed transfer (or 4 if all transfers are successful) ▸ **estimateGasAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2222](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2222)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3799](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3799)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. @@ -12304,11 +3346,47 @@ Name | Type | Description | The hash of the transaction +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4048](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4048)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *number[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4000](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4000)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2353](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2353)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3965](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3965)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used @@ -12326,46 +3404,52 @@ Name | Type | Description | The ABI encoded transaction data as a string -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2386](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2386)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - #### sendTransactionAsync -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2101](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2101)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3688)* 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 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 | +------ | ------ | ------ | +`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 | **Returns:** *`Promise`* The hash of the transaction +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3843](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3843)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAddresses` | string[] | +`takerAssetFillAmounts` | `BigNumber`[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + ___ ### getTransferableAssetAmount #### ▪ **getTransferableAssetAmount**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2397](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2397)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4061](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4061)* Gets the amount of an asset transferable by the owner. @@ -12373,7 +3457,7 @@ Gets the amount of an asset transferable by the owner. ▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2407](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2407)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4071](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4071)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -12392,6 +3476,12358 @@ Name | Type | Default | Description | The amount of the asset tranferable by the owner. NOTE: If the `assetData` encodes data for multiple assets, the `transferableAssetAmount` will represent the amount of times the entire `assetData` can be transferred. To calculate the total individual transferable amounts, this scaled `transferableAmount` must be multiplied by the individual asset amounts located within the `assetData`. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4153](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4153)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4141)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4126](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4126)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Address of the owner of the asset. | +`assetData` | string | Description of tokens, per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +
+ +# Class: 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:1282](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1282)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC20TokenContract.deployedBytecode | + +**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b50600436106100725760003560e01c806370a082311161005057806370a0823114610121578063a9059cbb14610154578063dd62ed3e1461018d57610072565b8063095ea7b31461007757806318160ddd146100c457806323b872dd146100de575b600080fd5b6100b06004803603604081101561008d57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81351690602001356101c8565b604080519115158252519081900360200190f35b6100cc61023b565b60408051918252519081900360200190f35b6100b0600480360360608110156100f457600080fd5b5073ffffffffffffffffffffffffffffffffffffffff813581169160208101359091169060400135610241565b6100cc6004803603602081101561013757600080fd5b503573ffffffffffffffffffffffffffffffffffffffff1661049d565b6100b06004803603604081101561016a57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81351690602001356104c5565b6100cc600480360360408110156101a357600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81358116916020013516610652565b33600081815260016020908152604080832073ffffffffffffffffffffffffffffffffffffffff8716808552908352818420869055815186815291519394909390927f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925928290030190a350600192915050565b60025490565b73ffffffffffffffffffffffffffffffffffffffff83166000908152602081905260408120548211156102d557604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601a60248201527f45524332305f494e53554646494349454e545f42414c414e4345000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8416600090815260016020908152604080832033845290915290205482111561037457604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601c60248201527f45524332305f494e53554646494349454e545f414c4c4f57414e434500000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8316600090815260208190526040902054828101101561040a57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601060248201527f55494e543235365f4f564552464c4f5700000000000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff80841660008181526020818152604080832080548801905593881680835284832080548890039055600182528483203384528252918490208054879003905583518681529351929391927fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9281900390910190a35060019392505050565b73ffffffffffffffffffffffffffffffffffffffff1660009081526020819052604090205490565b3360009081526020819052604081205482111561054357604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601a60248201527f45524332305f494e53554646494349454e545f42414c414e4345000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff831660009081526020819052604090205482810110156105d957604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601060248201527f55494e543235365f4f564552464c4f5700000000000000000000000000000000604482015290519081900360640190fd5b336000818152602081815260408083208054879003905573ffffffffffffffffffffffffffffffffffffffff871680845292819020805487019055805186815290519293927fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef929181900390910190a350600192915050565b73ffffffffffffffffffffffffffffffffffffffff91821660009081526001602090815260408083209390941682529190915220549056fea265627a7a723158205713efa92f66e67a8d01b80af8500df66bd6e9862dcf791e587181109d8ab0c464736f6c634300050b0032" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L51)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1266](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1266)* + +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:1224](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1224)* + +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:1249](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1249)* + +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:1255](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1255)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1035](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1035)* + +**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:993](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L993)* + +**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:968](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L968)* + +**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:869](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L869)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:878](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.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 | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address of the account owning tokens | +`_spender` | string | - | The address of the account able to transfer the tokens | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Amount of remaining tokens allowed to spent + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:959](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L959)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:947](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L947)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:932](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L932)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address of the account owning tokens | +`_spender` | string | The address of the account able to transfer the tokens | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### approve + +#### ▪ **approve**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L56)* + +`msg.sender` approves `_spender` to spend `_value` tokens + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:101](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L101)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:175](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L175)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L131)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L256)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:244](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L244)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L229)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:65](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L65)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:158](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L158)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:584](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L584)* + +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:592](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L592)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address from which the balance will be retrieved | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Balance of owner + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:663](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L663)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L651)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:640](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L640)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address from which the balance will be retrieved | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### totalSupply + +#### ▪ **totalSupply**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:267](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L267)* + +Query total supply of token + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:274](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L274)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +Total supply of token + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:338](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L338)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:326](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L326)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:316](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L316)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transfer + +#### ▪ **transfer**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L674)* + +send `value` token to `to` from `msg.sender` + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:716](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L716)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:783](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L783)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_to` | string | - | 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:746](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L746)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:861](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L861)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:849](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L849)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:834](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L834)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:683](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L683)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:766](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L766)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L349)* + +send `value` token to `to` from `from` on the condition it is approved by `from` + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:399](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L399)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The address of the sender | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:486](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L486)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:437](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L437)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The address of the sender | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:573](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L573)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L561)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:544](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L544)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The address of the sender | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:359](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L359)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The address of the sender | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:467](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L467)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# 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:1991](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1991)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC721TokenContract.deployedBytecode | + +**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b50600436106100a35760003560e01c80636352211e11610076578063a22cb4651161005b578063a22cb46514610211578063b88d4fde1461024c578063e985e9c5146102e9576100a3565b80636352211e146101af57806370a08231146101cc576100a3565b8063081812fc146100a8578063095ea7b3146100ee57806323b872dd1461012957806342842e0e1461016c575b600080fd5b6100c5600480360360208110156100be57600080fd5b5035610338565b6040805173ffffffffffffffffffffffffffffffffffffffff9092168252519081900360200190f35b6101276004803603604081101561010457600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135169060200135610360565b005b6101276004803603606081101561013f57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff813581169160208101359091169060400135610482565b6101276004803603606081101561018257600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135811691602081013590911690604001356107ef565b6100c5600480360360208110156101c557600080fd5b5035610989565b6101ff600480360360208110156101e257600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610a20565b60408051918252519081900360200190f35b6101276004803603604081101561022757600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81351690602001351515610acd565b6101276004803603608081101561026257600080fd5b73ffffffffffffffffffffffffffffffffffffffff8235811692602081013590911691604082013591908101906080810160608201356401000000008111156102aa57600080fd5b8201836020820111156102bc57600080fd5b803590602001918460018302840111640100000000831117156102de57600080fd5b509092509050610b66565b610324600480360360408110156102ff57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81358116916020013516610d31565b604080519115158252519081900360200190f35b60009081526001602052604090205473ffffffffffffffffffffffffffffffffffffffff1690565b600061036b82610989565b90503373ffffffffffffffffffffffffffffffffffffffff8216148061039657506103968133610d31565b61040157604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f4552433732315f494e56414c49445f53454e4445520000000000000000000000604482015290519081900360640190fd5b60008281526001602052604080822080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff87811691821790925591518593918516917f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92591a4505050565b73ffffffffffffffffffffffffffffffffffffffff821661050457604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601660248201527f4552433732315f5a45524f5f544f5f4144445245535300000000000000000000604482015290519081900360640190fd5b600061050f82610989565b90508073ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff16146105ab57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f4552433732315f4f574e45525f4d49534d415443480000000000000000000000604482015290519081900360640190fd5b3360006105b784610338565b90508273ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1614806105f857506105f88383610d31565b8061062e57508173ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16145b61069957604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601660248201527f4552433732315f494e56414c49445f5350454e44455200000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8116156106ea57600084815260016020526040902080547fffffffffffffffffffffffff00000000000000000000000000000000000000001690555b60008481526020818152604080832080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff8a811691909117909155891683526002909152902054610753906001610d6c565b73ffffffffffffffffffffffffffffffffffffffff8088166000908152600260205260408082209390935590871681522054610790906001610d90565b73ffffffffffffffffffffffffffffffffffffffff808716600081815260026020526040808220949094559251879391928a16917fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef91a4505050505050565b6107fa838383610482565b813b801561098357604080517f150b7a0200000000000000000000000000000000000000000000000000000000815233600482015273ffffffffffffffffffffffffffffffffffffffff8681166024830152604482018590526080606483015260006084830181905292519086169163150b7a029160c480830192602092919082900301818787803b15801561088f57600080fd5b505af11580156108a3573d6000803e3d6000fd5b505050506040513d60208110156108b957600080fd5b505160405190915080602f610e5b8239602f01905060405180910390207bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19161461098157604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4552433732315f494e56414c49445f53454c4543544f52000000000000000000604482015290519081900360640190fd5b505b50505050565b60008181526020819052604081205473ffffffffffffffffffffffffffffffffffffffff1680610a1a57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601160248201527f4552433732315f5a45524f5f4f574e4552000000000000000000000000000000604482015290519081900360640190fd5b92915050565b600073ffffffffffffffffffffffffffffffffffffffff8216610aa457604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601160248201527f4552433732315f5a45524f5f4f574e4552000000000000000000000000000000604482015290519081900360640190fd5b5073ffffffffffffffffffffffffffffffffffffffff1660009081526002602052604090205490565b33600081815260036020908152604080832073ffffffffffffffffffffffffffffffffffffffff87168085529083529281902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016861515908117909155815190815290519293927f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31929181900390910190a35050565b610b71858585610482565b833b8015610d29576040517f150b7a02000000000000000000000000000000000000000000000000000000008152336004820181815273ffffffffffffffffffffffffffffffffffffffff89811660248501526044840188905260806064850190815260848501879052600094918a169363150b7a029390928c928b928b928b929060a401848480828437600081840152601f19601f8201169050808301925050509650505050505050602060405180830381600087803b158015610c3557600080fd5b505af1158015610c49573d6000803e3d6000fd5b505050506040513d6020811015610c5f57600080fd5b505160405190915080602f610e5b8239602f01905060405180910390207bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614610d2757604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4552433732315f494e56414c49445f53454c4543544f52000000000000000000604482015290519081900360640190fd5b505b505050505050565b73ffffffffffffffffffffffffffffffffffffffff918216600090815260036020908152604080832093909416825291909152205460ff1690565b600082821115610d8a57610d8a610d8560028585610db3565b610e52565b50900390565b600082820183811015610dac57610dac610d8560008686610db3565b9392505050565b606063e946c1bb60e01b84848460405160240180846003811115610dd357fe5b60ff1681526020018381526020018281526020019350505050604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff838183161783525050505090509392505050565b805160208201fdfe6f6e455243373231526563656976656428616464726573732c616464726573732c75696e743235362c627974657329a265627a7a723158204bc74831490bca4fbe1805808d58d6b0e12f618a37565e744e91d8dc73dc18b164736f6c634300050c0032" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L61)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1975](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1975)* + +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:1933](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1933)* + +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:1958](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1958)* + +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:1964](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1964)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1664](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1664)* + +**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:1622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1622)* + +**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:1597](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1597)* + +**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:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L68)* + +The zero address indicates there is no approved address. +Throws unless `msg.sender` is the current NFT owner, or an authorized +operator of the current owner. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:113](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L113)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L186)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:143](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L143)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:267](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L267)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:255](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L255)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:240](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L240)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:77](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L77)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L170)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_approved` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:279](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L279)* + +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:287](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L287)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | An address for whom to query the balance | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The number of NFTs owned by `_owner`, possibly zero + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L358)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:346](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L346)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L335)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | An address for whom to query the balance | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getApproved + +#### ▪ **getApproved**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:369](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L369)* + +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:377](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L377)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_tokenId` | `BigNumber` | - | The NFT to find the approved address for | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The approved address for this NFT, or the zero address if there is none + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L448)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L436)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:425](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L425)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The NFT to find the approved address for | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### isApprovedForAll + +#### ▪ **isApprovedForAll**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:456](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L456)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:465](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L465)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address that owns the NFTs | +`_operator` | string | - | The address that acts on behalf of the owner | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +True if `_operator` is an approved operator for `_owner`, false otherwise + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:546](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L546)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:534](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L534)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:519](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L519)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address that owns the NFTs | +`_operator` | string | The address that acts on behalf of the owner | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### ownerOf + +#### ▪ **ownerOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:558](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L558)* + +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:566](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L566)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_tokenId` | `BigNumber` | - | The identifier for an NFT | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The address of the owner of the NFT + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:637](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L637)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:625](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L625)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:614](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L614)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The identifier for an NFT | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### safeTransferFrom1 + +#### ▪ **safeTransferFrom1**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:649](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L649)* + +This works identically to the other function with an extra data parameter, +except this function just sets data to "". + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:699](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L699)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:785](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L785)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | 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:737](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L737)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:872](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L872)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:860](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L860)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:843](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L843)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:659](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L659)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:767](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L767)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### safeTransferFrom2 + +#### ▪ **safeTransferFrom2**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:889](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L889)* + +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. When transfer is complete, this function +checks if `_to` is a smart contract (code size > 0). If so, it calls +`onERC721Received` on `_to` and throws if the return value is not +`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:944](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L944)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1045](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1045)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:986](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L986)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1136)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1124](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1124)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, `BigNumber`, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1107](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1107)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:900](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L900)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1019](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1019)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`_data` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### setApprovalForAll + +#### ▪ **setApprovalForAll**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1148)* + +Emits the ApprovalForAll event. The contract MUST allow +multiple operators per owner. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1193](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1193)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_operator`: string, `_approved`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1270](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1270)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1227](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1227)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1351](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1351)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1339](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1339)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, boolean]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1324](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1324)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1157](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1157)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1254](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1254)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_operator` | string | +`_approved` | boolean | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1365](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1365)* + +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1415](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1415)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1501](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1501)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1453](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1453)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1588](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1588)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1576](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1576)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1559](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1559)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1375](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1375)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1483)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ExchangeContract + + +## Constructors + + + +\+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ExchangeContract](#class-exchangecontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:13414](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13414)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ExchangeContract.deployedBytecode | + +**Returns:** *[ExchangeContract](#class-exchangecontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x6080604052600436106102d15760003560e01c80638da5cb5b11610179578063beee2e14116100d6578063dd885e2d1161008a578063eea086ba11610064578063eea086ba14610715578063f2fde38b1461072a578063fc74896d1461074a576102d1565b8063dd885e2d146106cd578063dedfc1f1146106ef578063e14b58c414610702576102d1565b8063c26cfecd116100bb578063c26cfecd14610678578063c585bb931461068d578063d9bfa73e146106ad576102d1565b8063beee2e1414610645578063c0fa16cc14610658576102d1565b80639d3fa4b91161012d578063a6c3bf3311610112578063a6c3bf33146105ff578063b04fbddd14610612578063b718e29214610632576102d1565b80639d3fa4b9146105b2578063a12dcc6f146105df576102d1565b80639331c7421161015e5780639331c7421461056c5780639694a4021461058c5780639b44d5561461059f576102d1565b80638da5cb5b146105375780638ea8dfe41461054c576102d1565b80636a1a80fd116102325780638171c407116101e657806388ec79fb116101c057806388ec79fb146104e45780638bc8efb3146105045780638d45cd2314610517576102d1565b80638171c4071461048f57806382c174d0146104af578063850a1501146104cf576102d1565b806377fcce681161021757806377fcce681461044957806378d29ac11461045c5780637b8e35141461046f576102d1565b80636a1a80fd146104165780636fcf3e9e14610436576102d1565b80632da629871161028957806346c02d7a1161026e57806346c02d7a146103c35780634f9559b1146103d657806360704108146103e9576102d1565b80632da629871461038e578063369da099146103a3576102d1565b80632280c910116102ba5780632280c9101461032e578063288cdc911461034e5780632ac126221461036e576102d1565b80630228e168146102d65780631ce4c78b1461030c575b600080fd5b3480156102e257600080fd5b506102f66102f1366004614e64565b61076a565b60405161030391906154c4565b60405180910390f35b34801561031857600080fd5b5061032161077f565b60405161030391906154cf565b61034161033c366004615108565b610785565b60405161030391906156a0565b34801561035a57600080fd5b50610321610369366004614e64565b6107c7565b34801561037a57600080fd5b506102f6610389366004614e64565b6107d9565b6103a161039c366004614f82565b6107ee565b005b6103b66103b1366004614d60565b610812565b60405161030391906159c2565b6103a16103d1366004614e64565b610939565b6103a16103e4366004614e64565b6109ac565b3480156103f557600080fd5b50610409610404366004614eed565b610ab9565b604051610303919061535b565b610429610424366004614c40565b610b07565b604051610303919061594b565b610429610444366004614c40565b610b3f565b6103a1610457366004614b2a565b610b5d565b6103b661046a366004614d60565b610c20565b34801561047b57600080fd5b506102f661048a366004614af6565b610d70565b34801561049b57600080fd5b506102f66104aa366004614ea0565b610d90565b3480156104bb57600080fd5b506102f66104ca366004614e7c565b610def565b3480156104db57600080fd5b50610409610e0f565b6104f76104f236600461500c565b610e2b565b60405161030391906159d0565b6103b6610512366004614d60565b610e49565b34801561052357600080fd5b506102f6610532366004615108565b610e7d565b34801561054357600080fd5b50610409610ea2565b61055f61055a366004614cdc565b610ebe565b60405161030391906154b1565b34801561057857600080fd5b506103a1610587366004614e64565b610fe9565b61055f61059a366004614cdc565b611031565b6103b66105ad3660046150a8565b6110f8565b3480156105be57600080fd5b506105d26105cd366004614f82565b61111d565b6040516103039190615a12565b3480156105eb57600080fd5b506102f66105fa366004614fb5565b611201565b6103b661060d366004614d60565b611226565b34801561061e57600080fd5b506103a161062d366004614b65565b61125a565b6104f761064036600461500c565b611306565b61055f610653366004614cdc565b611324565b34801561066457600080fd5b506103a1610673366004614adb565b6113d9565b34801561068457600080fd5b5061032161147c565b34801561069957600080fd5b506103a16106a8366004614adb565b611482565b3480156106b957600080fd5b506103216106c8366004614af6565b611616565b3480156106d957600080fd5b506106e2611633565b604051610303919061562b565b6103a16106fd366004614c0d565b611657565b6103b66107103660046150a8565b611699565b34801561072157600080fd5b506104096116b4565b34801561073657600080fd5b506103a1610745366004614adb565b6116d0565b61075d610758366004614db3565b611748565b6040516103039190615433565b60056020526000908152604090205460ff1681565b60035481565b606061078f61187b565b156107a55761079e838361189d565b90506107c1565b6107ad6119b7565b6107b7838361189d565b90506107c16119f9565b92915050565b60096020526000908152604090205481565b600a6020526000908152604090205460ff1681565b6107f6611a2b565b6107ff81611a9a565b610807611ad7565b61080f611aeb565b50565b61081a614561565b61082261187b565b156108b857835160005b8181146108b157600061084c846020015187611b1590919063ffffffff16565b9050610856614561565b61088788848151811061086557fe5b60200260200101518388868151811061087a57fe5b6020026020010151611b34565b90506108938582611c75565b9450868560200151106108a75750506108b1565b505060010161082c565b5050610932565b6108c06119b7565b835160005b8181146109285760006108e5846020015187611b1590919063ffffffff16565b90506108ef614561565b6108fe88848151811061086557fe5b905061090a8582611c75565b94508685602001511061091e575050610928565b50506001016108c5565b50506109326119f9565b9392505050565b610941611a2b565b600061094b611d10565b600083815260076020908152604080832073ffffffffffffffffffffffffffffffffffffffff90941683529290522080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016600117905550610807611ad7565b6109b4611a2b565b60006109be611d10565b9050600073ffffffffffffffffffffffffffffffffffffffff821633146109e557336109e8565b60005b73ffffffffffffffffffffffffffffffffffffffff8084166000908152600b60209081526040808320938516835292905220549091506001840190808211610a3d57610a3d610a38858584611d42565b611de7565b73ffffffffffffffffffffffffffffffffffffffff8085166000818152600b602090815260408083209488168084529490915290819020859055517f82af639571738f4ebd4268fb0363d8957ebe1bbb9e78dba5ebd69eed39b154f090610aa59086906154cf565b60405180910390a350505050610807611ad7565b7fffffffff00000000000000000000000000000000000000000000000000000000811660009081526002602052604090205473ffffffffffffffffffffffffffffffffffffffff165b919050565b610b0f614590565b610b17611a2b565b610b25858585856001611def565b9050610b2f611ad7565b610b37611aeb565b949350505050565b610b47614590565b610b4f611a2b565b610b25858585856000611def565b610b65611a2b565b6000610b6f611d10565b73ffffffffffffffffffffffffffffffffffffffff8181166000818152600860209081526040808320948916808452949091529081902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00168715151790555192935090917fa8656e308026eeabce8f0bc18048433252318ab80ac79da0b3d3d8697dfba89190610c039086906154c4565b60405180910390a350610c14611ad7565b610c1c611aeb565b5050565b610c28614561565b610c3061187b565b15610cee57835160005b8181146108b1578251600090610c5790879063ffffffff611b1516565b90506000610c94888481518110610c6a57fe5b602002602001015160a00151898581518110610c8257fe5b6020026020010151608001518461215c565b9050610c9e614561565b610cc2898581518110610cad57fe5b60200260200101518389878151811061087a57fe5b9050610cce8682611c75565b955087866000015110610ce3575050506108b1565b505050600101610c3a565b610cf66119b7565b835160005b818114610928578251600090610d1890879063ffffffff611b1516565b90506000610d2b888481518110610c6a57fe5b9050610d35614561565b610d44898581518110610cad57fe5b9050610d508682611c75565b955087866000015110610d6557505050610928565b505050600101610cfb565b600860209081526000928352604080842090915290825290205460ff1681565b600080610d9e85858561217e565b90506005816008811115610dae57fe5b1480610dc557506007816008811115610dc357fe5b145b15610dda57610dda610a3860058787876121fd565b610de6818686866122a5565b95945050505050565b600760209081526000928352604080842090915290825290205460ff1681565b60045473ffffffffffffffffffffffffffffffffffffffff1681565b610e336145b8565b610e3b611a2b565b610b25858585856000612515565b610e51614561565b610e5c848484610c20565b9050828160000151101561093257610932610a386000858460000151612602565b600080610e956001548561262190919063ffffffff16565b9050610b37848285612635565b60005473ffffffffffffffffffffffffffffffffffffffff1681565b6060610ec861187b565b15610f6b578351604080518281526020808402820101909152818015610f0857816020015b610ef5614561565b815260200190600190039081610eed5790505b50915060005b8181146108b157610f4c868281518110610f2457fe5b6020026020010151868381518110610f3857fe5b602002602001015186848151811061087a57fe5b838281518110610f5857fe5b6020908102919091010152600101610f0e565b610f736119b7565b8351604080518281526020808402820101909152818015610fae57816020015b610f9b614561565b815260200190600190039081610f935790505b50915060005b81811461092857610fca868281518110610f2457fe5b838281518110610fd657fe5b6020908102919091010152600101610fb4565b610ff16126bb565b7f3a3e76d7a75e198aef1f53137e4f2a8a2ec74e2e9526db8404d08ccc9f1e621d60035482604051611024929190615543565b60405180910390a1600355565b606061103b611a2b565b835160408051828152602080840282010190915281801561107657816020015b611063614561565b81526020019060019003908161105b5790505b50915060005b8181146110e6576110c786828151811061109257fe5b60200260200101518683815181106110a657fe5b60200260200101518684815181106110ba57fe5b6020026020010151612702565b8382815181106110d357fe5b602090810291909101015260010161107c565b50506110f0611ad7565b610932611aeb565b611100614561565b611108611a2b565b611113848484612702565b90506110f0611ad7565b6111256145ec565b61112e826127a4565b60408301526020820152608082015161114e5760015b60ff168152610b02565b60a082015161115e576002611144565b8160a00151816040015110611174576005611144565b8161010001514210611187576004611144565b6020808201516000908152600a909152604090205460ff16156111ab576006611144565b610120820151825173ffffffffffffffffffffffffffffffffffffffff9081166000908152600b6020908152604080832060608801519094168352929052205411156111f8576006611144565b60038152919050565b600080611219600154856127d590919063ffffffff16565b9050610b378482856127e4565b61122e614561565b611239848484610812565b9050828160200151101561093257610932610a386001858460200151612602565b835160005b8181146112ca576112c28160001b87838151811061127957fe5b602002602001015187848151811061128d57fe5b60200260200101518785815181106112a157fe5b60200260200101518786815181106112b557fe5b6020026020010151612839565b60010161125f565b506040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016112fd90615914565b60405180910390fd5b61130e6145b8565b611316611a2b565b610b25858585856001612515565b606061132e611a2b565b835160408051828152602080840282010190915281801561136957816020015b611356614561565b81526020019060019003908161134e5790505b50915060005b8181146110e6576113ba86828151811061138557fe5b602002602001015186838151811061139957fe5b60200260200101518684815181106113ad57fe5b60200260200101516129f3565b8382815181106113c657fe5b602090810291909101015260010161136f565b6113e16126bb565b6004546040517fe1a5430ebec577336427f40f15822f1f36c5e3509ff209d6db9e6c9e6941cb0b9161142d9173ffffffffffffffffffffffffffffffffffffffff90911690849061537c565b60405180910390a1600480547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055565b60015481565b61148a6126bb565b60008173ffffffffffffffffffffffffffffffffffffffff1663ae25532e6040518163ffffffff1660e01b815260040160206040518083038186803b1580156114d257600080fd5b505afa1580156114e6573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525061150a9190810190614f09565b7fffffffff00000000000000000000000000000000000000000000000000000000811660009081526002602052604090205490915073ffffffffffffffffffffffffffffffffffffffff16801561156857611568610a388383612a26565b7fffffffff0000000000000000000000000000000000000000000000000000000082166000908152600260205260409081902080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff8616179055517fd2c6b762299c609bdb96520b58a49bfb80186934d4f71a86a367571a15c03194906116099084908690615658565b60405180910390a1505050565b600b60209081526000928352604080842090915290825290205481565b7f20c13b0b0000000000000000000000000000000000000000000000000000000081565b61165f611a2b565b805160005b81811461168f5761168783828151811061167a57fe5b6020026020010151611a9a565b600101611664565b5050610807611ad7565b6116a1614561565b6116a9611a2b565b6111138484846129f3565b60065473ffffffffffffffffffffffffffffffffffffffff1681565b6116d86126bb565b73ffffffffffffffffffffffffffffffffffffffff8116611703576116fe610a38612ac8565b61080f565b6000805473ffffffffffffffffffffffffffffffffffffffff83167fffffffffffffffffffffffff000000000000000000000000000000000000000090911617905550565b606061175261187b565b156117f457825160408051828152602080840282010190915260609082801561178f57816020015b606081526020019060019003908161177a5790505b50905060005b8281146117eb576117cc8682815181106117ab57fe5b60200260200101518683815181106117bf57fe5b602002602001015161189d565b8282815181106117d857fe5b6020908102919091010152600101611795565b509150506107c1565b6117fc6119b7565b825160408051828152602080840282010190915260609082801561183457816020015b606081526020019060019003908161181f5790505b50905060005b82811461186f576118508682815181106117ab57fe5b82828151811061185c57fe5b602090810291909101015260010161183a565b509150506107c16119f9565b6000547501000000000000000000000000000000000000000000900460ff1690565b606060006118b66001548561262190919063ffffffff16565b90506118c3848483612aff565b60608401516118d28180612bd3565b60008281526005602052604080822080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00166001179055608087015190516060913091611920919061530e565b600060405180830381855af49150503d806000811461195b576040519150601f19603f3d011682016040523d82523d6000602084013e611960565b606091505b50915091508161197757611977610a388583612c36565b611982836000612bd3565b60405184907fa4a7329f1dd821363067e07d359e347b4af9b1efe4b6cccf13240228af3c800d90600090a29695505050505050565b600080547fffffffffffffffffffff00ffffffffffffffffffffffffffffffffffffffffff167501000000000000000000000000000000000000000000179055565b600080547fffffffffffffffffffff00ffffffffffffffffffffffffffffffffffffffffff169055611a29612c53565b565b60005474010000000000000000000000000000000000000000900460ff1615611a5957611a59610a38612c88565b600080547fffffffffffffffffffffff00ffffffffffffffffffffffffffffffffffffffff1674010000000000000000000000000000000000000000179055565b611aa26145ec565b611aab8261111d565b9050611ab78282612cbf565b805160ff16600314611ac9575061080f565b610c1c828260200151612d6e565b611adf61187b565b611a2957611a29612c53565b600080547fffffffffffffffffffffff00ffffffffffffffffffffffffffffffffffffffff169055565b600082821115611b2e57611b2e610a3860028585612e17565b50900390565b611b3c614561565b6040516060907f9b44d5560000000000000000000000000000000000000000000000000000000090611b7690879087908790602401615a58565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050509050600060603073ffffffffffffffffffffffffffffffffffffffff1683604051611bfe919061530e565b600060405180830381855af49150503d8060008114611c39576040519150601f19603f3d011682016040523d82523d6000602084013e611c3e565b606091505b50915091508115611c6b57805160a014611c5457fe5b80806020019051611c689190810190614f25565b93505b5050509392505050565b611c7d614561565b81518351611c909163ffffffff612e3616565b815260208083015190840151611cab9163ffffffff612e3616565b602082015260408083015190840151611cc99163ffffffff612e3616565b604082015260608083015190840151611ce79163ffffffff612e3616565b606082015260808083015190840151611d059163ffffffff612e3616565b608082015292915050565b60065460009073ffffffffffffffffffffffffffffffffffffffff16818115611d395781611d3b565b335b9250505090565b6060634ad3127560e01b848484604051602401611d61939291906153a3565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff000000000000000000000000000000000000000000000000000000009093169290921790915290509392505050565b805160208201fd5b611df7614590565b8551611e0a57611e0a610a386000612e52565b8451611e1d57611e1d610a386001612e52565b8351865114611e3357611e33610a386002612e52565b8251855114611e4957611e49610a386003612e52565b8551604051908082528060200260200182016040528015611e8457816020015b611e71614561565b815260200190600190039081611e695790505b5081528451604080518281526020808402820101909152908015611ec257816020015b611eaf614561565b815260200190600190039081611ea75790505b506020820152600080611ed361460c565b88600081518110611ee057fe5b60200260200101519050611ef261460c565b88600081518110611eff57fe5b602002602001015190506000611f14836127a4565b9150506000611f22836127a4565b915050611f2d614561565b611f35614561565b611f3d6145b8565b611f7087878f8c81518110611f4e57fe5b60200260200101518f8c81518110611f6257fe5b60200260200101518f612515565b805160200151909150611f8a90869063ffffffff612e3616565b9450611fa781602001516020015185612e3690919063ffffffff16565b9350611fb7838260000151611c75565b9250611fc7828260200151611c75565b9150611fe481604001518b60400151612e3690919063ffffffff16565b60408b0152606080820151908b01516120029163ffffffff612e3616565b60608b015260a087015185106120ad578951805160018b019a859291811061202657fe5b60200260200101819052506040518060a0016040528060008152602001600081526020016000815260200160008152602001600081525092508e5189141561208a57818a60200151898151811061207957fe5b60200260200101819052505061214b565b8e898151811061209657fe5b602002602001015196506120a9876127a4565b9550505b8560a00151841061214557818a6020015189806001019a50815181106120cf57fe5b60200260200101819052506040518060a0016040528060008152602001600081526020016000815260200160008152602001600081525091508d5188141561212257828a600001518a8151811061207957fe5b8d888151811061212e57fe5b60200260200101519550612141866127a4565b9450505b50611f35565b505050505050505095945050505050565b6000610b3783612172868563ffffffff612ef116565b9063ffffffff612f2216565b600061218b848484612f4c565b905073ffffffffffffffffffffffffffffffffffffffff83166121b8576121b8610a3860068686866121fd565b600881818111156121c557fe5b60ff16106121dd576121dd610a3860038686866121fd565b60008160088111156121eb57fe5b141561093257610932610a3860048686865b6060637e5a231860e01b8585858560405160240161221e94939291906158b9565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909316929092179091529050949350505050565b600060018560088111156122b557fe5b14156122dc5781516001146122d4576122d4610a3860028686866121fd565b506000610b37565b60028560088111156122ea57fe5b14156123e357815160421461230957612309610a3860028686866121fd565b60008260008151811061231857fe5b016020015160f81c9050600061233584600163ffffffff612f8b16565b9050600061234a85602163ffffffff612f8b16565b9050600060018885858560405160008152602001604052604051612371949392919061560d565b6020604051602081039080840390855afa158015612393573d6000803e3d6000fd5b50506040517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0015173ffffffffffffffffffffffffffffffffffffffff8981169116149550610b37945050505050565b60038560088111156123f157fe5b141561249e57815160421461241057612410610a3860028686866121fd565b60008260008151811061241f57fe5b016020015160f81c9050600061243c84600163ffffffff612f8b16565b9050600061245185602163ffffffff612f8b16565b90506000600188604051602001612468919061532a565b6040516020818303038152906040528051906020012085858560405160008152602001604052604051612371949392919061560d565b60048560088111156124ac57fe5b14156124c4576124bd848484612fb5565b9050610b37565b60068560088111156124d257fe5b146124d957fe5b50600083815260076020908152604080832073ffffffffffffffffffffffffffffffffffffffff8616845290915290205460ff16949350505050565b61251d6145b8565b61016080870151610140808801919091528701519086015261253d6145ec565b6125468761111d565b90506125506145ec565b6125598761111d565b90506000612565611d10565b90506125738984838a6131ab565b61257f888383896131ab565b6125938989856020015185602001516132e1565b6125ac8989856040015185604001516003543a8b61332c565b93506125c78982856020015186604001518860000151613481565b6125e08882846020015185604001518860200151613481565b6125f6836020015183602001518b8b858961355f565b50505095945050505050565b60606318e4b14160e01b848484604051602401611d619392919061589e565b60006109328261263085613706565b61378e565b60608301516000908161264985838661217e565b9050600581600881111561265957fe5b141561267b5761267461266c87876137c8565b868487613800565b92506126b2565b600781600881111561268957fe5b14156126a35761267461269c87876137c8565b83866138b4565b6126af818684876122a5565b92505b50509392505050565b60005473ffffffffffffffffffffffffffffffffffffffff163314611a2957600054611a2990610a3890339073ffffffffffffffffffffffffffffffffffffffff166138c3565b61270a614561565b6127126145ec565b61271b8561111d565b90506000612727611d10565b9050612735868383876131ab565b600061275283604001518860a00151611b1590919063ffffffff16565b9050600061276087836138e0565b905061277088826003543a6138f6565b945060008460200151905061278c89858388604001518a613481565b612798818a868961396d565b50505050509392505050565b6000806127bc600154846127d590919063ffffffff16565b6000818152600960205260409020549092509050915091565b60006109328261263085613a04565b8251600090816127f585838661217e565b9050600581600881111561280557fe5b14156128185761267461266c8787613adb565b600781600881111561282657fe5b14156126a35761267461269c8787613adb565b80156129ec57600384511161285757612857610a3860008787613b13565b6000612869858263ffffffff613b3216565b7fffffffff00000000000000000000000000000000000000000000000000000000811660009081526002602052604090205490915073ffffffffffffffffffffffffffffffffffffffff16806128c8576128c8610a3860018989613b13565b6040516060907fa85e59e400000000000000000000000000000000000000000000000000000000906129049089908990899089906024016156b3565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050509050600060608373ffffffffffffffffffffffffffffffffffffffff168360405161298c919061530e565b6000604051808303816000865af19150503d80600081146129c9576040519150601f19603f3d011682016040523d82523d6000602084013e6129ce565b606091505b5091509150816129e6576129e6610a388b8b84613b7e565b50505050505b5050505050565b6129fb614561565b612a06848484612702565b90508281602001511461093257610932610a386002858460200151612602565b60606311c7b72060e01b8383604051602401612a43929190615658565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff0000000000000000000000000000000000000000000000000000000090931692909217909152905092915050565b60408051808201909152600481527fe69edc3e00000000000000000000000000000000000000000000000000000000602082015290565b82602001514210612b1857612b18610a38600183613b9d565b60408301513a8114612b3257612b32610a38833a84613bba565b60065473ffffffffffffffffffffffffffffffffffffffff168015612b5e57612b5e610a388483613bd9565b60008381526005602052604090205460ff1615612b8357612b83610a38600085613b9d565b606085015173ffffffffffffffffffffffffffffffffffffffff81163314801590612bb65750612bb4868587612635565b155b15612bcb57612bcb610a3860018684896121fd565b505050505050565b73ffffffffffffffffffffffffffffffffffffffff82163314610c1c576006805473ffffffffffffffffffffffffffffffffffffffff83167fffffffffffffffffffffffff00000000000000000000000000000000000000009091161790555050565b60606320d11f6160e01b8383604051602401612a43929190615551565b3031801561080f57604051339082156108fc029083906000818181858888f19350505050158015610c1c573d6000803e3d6000fd5b60408051808201909152600481527f0c3b823f00000000000000000000000000000000000000000000000000000000602082015290565b606082015173ffffffffffffffffffffffffffffffffffffffff1615612d1357606082015173ffffffffffffffffffffffffffffffffffffffff163314612d1357612d13610a386002836020015133613bf6565b6000612d1d611d10565b90508073ffffffffffffffffffffffffffffffffffffffff16836000015173ffffffffffffffffffffffffffffffffffffffff1614612d6957612d69610a386000846020015184613bf6565b505050565b6000818152600a60205260409081902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001660011790558281015183516101408501516101608601519351859473ffffffffffffffffffffffffffffffffffffffff9485169493909316927f02c310a9a43963ff31a754a4099cc435ed498049687539d72d7818d9b093415c92612e0b92909190339061571b565b60405180910390a45050565b606063e946c1bb60e01b848484604051602401611d6193929190615846565b60008282018381101561093257610932610a3860008686612e17565b606063d4092f4f60e01b82604051602401612e6d9190615833565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909316929092179091529050919050565b600082612f00575060006107c1565b82820282848281612f0d57fe5b041461093257610932610a3860018686612e17565b600081612f3857612f38610a3860038585612e17565b6000828481612f4357fe5b04949350505050565b6000815160001415612f6857612f68610a3860028686866121fd565b81600183510381518110612f7857fe5b016020015160f81c6008811115610b3757fe5b60008160200183511015612fac57612fac610a386005855185602001613c15565b50016020015190565b8051600090612fec837fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff830163ffffffff613c3416565b6040516060907f1626ba7e00000000000000000000000000000000000000000000000000000000906130249088908790602401615551565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff000000000000000000000000000000000000000000000000000000009093169290921790915290506130b3848363ffffffff613c3416565b600060608673ffffffffffffffffffffffffffffffffffffffff16836040516130dc919061530e565b600060405180830381855afa9150503d8060008114613117576040519150601f19603f3d011682016040523d82523d6000602084013e61311c565b606091505b509150915081801561312f575080516020145b15613191577fb06713810000000000000000000000000000000000000000000000000000000061316682600063ffffffff613b3216565b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614945050505050610932565b6131a0610a3889898985613c38565b505050509392505050565b825160ff166003146131da576131da610a388460200151856000015160ff1660068111156131d557fe5b613c59565b606084015173ffffffffffffffffffffffffffffffffffffffff161561322e57606084015173ffffffffffffffffffffffffffffffffffffffff16331461322e5761322e610a386002856020015133613bf6565b602084015173ffffffffffffffffffffffffffffffffffffffff1615613298578173ffffffffffffffffffffffffffffffffffffffff16846020015173ffffffffffffffffffffffffffffffffffffffff161461329857613298610a386001856020015185613bf6565b8351604084015115806132b557506132b584602001518284613c76565b156129ec576132c9858560200151846127e4565b6129ec576129ec610a386000866020015184866121fd565b60a080840151908501516132fa9163ffffffff612ef116565b608080850151908601516133139163ffffffff612ef116565b101561332657613326610a388383613cc9565b50505050565b6133346145b8565b60a088015160009061334c908863ffffffff611b1516565b905060006133638a608001518b60a0015184613ce6565b9050600061337e888b60a00151611b1590919063ffffffff16565b905060006133958b608001518c60a0015184613ce6565b905085156133b2576133ab8c8c85878587613d1a565b94506133c3565b6133c08c8c85878587613dec565b94505b84515160808d015160c08e01516133db929190613ce6565b85516040015284516020015160a08d015160e08e01516133fc929190613ce6565b85516060015260208501515160808c015160c08d015161341d929190613ce6565b856020015160400181815250506134458560200151602001518c60a001518d60e00151613ce6565b6020860151606001526000613460888a63ffffffff612ef116565b86516080908101829052602088015101525050505050979650505050505050565b602081015161349790839063ffffffff612e3616565b600960008581526020019081526020016000208190555082856040015173ffffffffffffffffffffffffffffffffffffffff16866000015173ffffffffffffffffffffffffffffffffffffffff167f6869791f0a34781b29882982cc39e882768cf2c96995c2a110c577c53bc932d58861014001518961016001518a61018001518b6101a001518b338a600001518b602001518c604001518d606001518e608001516040516135509b9a99989796959493929190615767565b60405180910390a45050505050565b8351835160408087015190860151610140870151855160200151613588918b9186908890612839565b6135a28a8961014001518686896020015160200151612839565b6135bc898861018001518584896020015160400151612839565b6135d68a8961018001518685896000015160400151612839565b6135ec8a89610140015186898960400151612839565b6136028988610140015185898960600151612839565b600061361a8b8b88600001516080015188888c613e85565b905080613637578551600060809182018190526020880151909101525b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1614801561368757506101a080890151908a01516136879163ffffffff613ee216565b156136c5576136c08b8a6101a0015189866136bb8b60200151606001518c6000015160600151612e3690919063ffffffff16565b612839565b6136f9565b6136df8a896101a0015189858a6020015160600151612839565b6136f98b8a6101a0015189868a6000015160600151612839565b5050505050505050505050565b608081810151825160208085015160408087015160609788015186519685019690962082517fec69816980a3a3ca4554410e60253953e9ff375ba4536a98adfa15cc71541508815294850195909552908301919091529481019490945273ffffffffffffffffffffffffffffffffffffffff9091169183019190915260a082015260c0902090565b6040517f19010000000000000000000000000000000000000000000000000000000000008152600281019290925260228201526042902090565b6040516060907fde047db40000000000000000000000000000000000000000000000000000000090612a439085908590602401615a83565b8051600090601581101561381e5761381e610a3860028787876121fd565b6000613852847fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffeb840163ffffffff613f0716565b73ffffffffffffffffffffffffffffffffffffffff80871660009081526008602090815260408083209385168352929052205490915060ff1661389c5761389c610a388683613f47565b6138a98188866015613f64565b979650505050505050565b6000610b378385846001613f64565b6060631de45ad160e01b8383604051602401612a4392919061537c565b60008183106138ef5781610932565b5090919050565b6138fe614561565b6020810184905260a0850151608086015161391a918691613ce6565b815260a085015160c0860151613931918691613ce6565b604082015260a085015160e086015161394b918691613ce6565b6060820152613960828463ffffffff612ef116565b6080820152949350505050565b613987848461016001518486600001518560200151612839565b6139a1848461014001518560000151858560000151612839565b6139bb84846101a001518486604001518560600151612839565b6139d984846101800151856000015186604001518560400151612839565b60006139ef85836080015186600001518661413b565b9050806129ec57600060808301525050505050565b6101408101516101608201516101808301516101a08401516000937ff80322eb8376aafb64eadf8f0d7623f22130fd9491a221e902b713cb984a753493909290916020871015613a5057fe5b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe087018051610140890180516101608b0180516101808d0180516101a08f0180519d89528c5160209d8e012087528b519b8d019b909b2084528951998c01999099208152875197909a019690962088526101e085209390945290529190529252919091529050919050565b6040516060907f3efe50c80000000000000000000000000000000000000000000000000000000090612a439085908590602401615a36565b606063488219a660e01b848484604051602401611d619392919061580b565b60008160040183511015613b5357613b53610a386003855185600401613c15565b5001602001517fffffffff000000000000000000000000000000000000000000000000000000001690565b6060634678472b60e01b848484604051602401611d619392919061556a565b606063f598518460e01b8383604051602401612a439291906158fd565b606063a26dac0960e01b848484604051602401611d61939291906155f7565b606063dec4aedf60e01b8383604051602401612a439291906154d8565b606063e53c76c860e01b848484604051602401611d6193929190615867565b6060632800659560e01b848484604051602401611d61939291906158ab565b9052565b6060631b8388f760e01b8585858560405160240161221e94939291906154fc565b606063fdb6ca8d60e01b8383604051602401612a43929190615595565b600080613c84858585612f4c565b90506004816008811115613c9457fe5b1480613cab57506005816008811115613ca957fe5b145b80610de657506007816008811115613cbf57fe5b1495945050505050565b606063b6555d6f60e01b8383604051602401612a43929190615543565b6000613cf3848484614181565b15613d0657613d06610a388585856141e7565b610b3783612172868563ffffffff612ef116565b613d226145b8565b81851184841184861115613d4257613d3b898686614206565b9250613d91565b86841115613d825782518790528251602001869052608088015160a0890151613d6c919089613ce6565b6020808501805192909252905101879052613d91565b613d8e87878787614243565b92505b8115613db7576020808401510151835151613db19163ffffffff611b1516565b60408401525b8015613ddf5782516020908101519084015151613dd99163ffffffff611b1516565b60608401525b50505b9695505050505050565b613df46145b8565b82841115613e0e57613e07878484614206565b9050613e5c565b82841015613e4d5780518590528051602090810185905281015184905260a08601516080870151613e4091908661426e565b6020808301510152613e5c565b613e5985858585614243565b90505b6020808201510151815151613e769163ffffffff611b1516565b60408201529695505050505050565b60045460009073ffffffffffffffffffffffffffffffffffffffff168015613ed85730316000613eb98a84848b8b8a6142c2565b9050613ecb89848385038b8a8a6142c2565b5060019350505050613de2565b6000915050613de2565b6000815183511480156109325750508051602091820120825192909101919091201490565b60008160140183511015613f2857613f28610a386004855185601401613c15565b50016014015173ffffffffffffffffffffffffffffffffffffffff1690565b606063a15c0d0660e01b8383604051602401612a4392919061537c565b8151600090613f7b8484830363ffffffff613c3416565b6040516060907f20c13b0b0000000000000000000000000000000000000000000000000000000090613fb390889088906024016156f6565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909316929092179091529050614042858363ffffffff613c3416565b600060608873ffffffffffffffffffffffffffffffffffffffff168360405161406b919061530e565b600060405180830381855afa9150503d80600081146140a6576040519150601f19603f3d011682016040523d82523d6000602084013e6140ab565b606091505b50915091508180156140be575080516020145b15614120577f20c13b0b000000000000000000000000000000000000000000000000000000006140f582600063ffffffff613b3216565b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614945050505050610b37565b61412f610a388a8a8a856143fa565b50505050949350505050565b60045460009073ffffffffffffffffffffffffffffffffffffffff1680156141775761416c868230318888886142c2565b506001915050610b37565b6000915050610b37565b60008261419357614193610a3861441b565b81158061419e575083155b156141ab57506000610932565b600083806141b557fe5b85840990506141ca858463ffffffff612ef116565b6141dc826103e863ffffffff612ef116565b101595945050505050565b606063339f3de260e01b848484604051602401611d61939291906155f7565b61420e6145b8565b60208082018051859052518101839052815101839052608084015160a0850151614239919085613ce6565b8151529392505050565b61424b6145b8565b805194909452835160209081019390935282840180519290925290519091015290565b600061427b848484614452565b1561428e5761428e610a388585856141e7565b610b37836121726142a682600163ffffffff611b1516565b6142b6888763ffffffff612ef116565b9063ffffffff612e3616565b60008385106142ce5750825b6040516060907fa3b4a3270000000000000000000000000000000000000000000000000000000090614308908690869089906024016153a3565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050509050600060608873ffffffffffffffffffffffffffffffffffffffff168484604051614391919061530e565b60006040518083038185875af1925050503d80600081146143ce576040519150601f19603f3d011682016040523d82523d6000602084013e6143d3565b606091505b5091509150816143ed576143ed610a388b898989866144b6565b5050509695505050505050565b6060635bd0428d60e01b8585858560405160240161221e94939291906153d4565b60408051808201909152600481527fa791837c00000000000000000000000000000000000000000000000000000000602082015290565b60008261446457614464610a3861441b565b81158061446f575083155b1561447c57506000610932565b6000838061448657fe5b85840990508361449c818363ffffffff611b1516565b816144a357fe5b0690506141ca858463ffffffff612ef116565b60606387cb1e7560e01b86868686866040516024016144d99594939291906155b2565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff0000000000000000000000000000000000000000000000000000000090931692909217909152905095945050505050565b6040518060a0016040528060008152602001600081526020016000815260200160008152602001600081525090565b6040518060800160405280606081526020016060815260200160008152602001600081525090565b60405180608001604052806145cb614561565b81526020016145d8614561565b815260200160008152602001600081525090565b604080516060810182526000808252602082018190529181019190915290565b604051806101c00160405280600073ffffffffffffffffffffffffffffffffffffffff168152602001600073ffffffffffffffffffffffffffffffffffffffff168152602001600073ffffffffffffffffffffffffffffffffffffffff168152602001600073ffffffffffffffffffffffffffffffffffffffff168152602001600081526020016000815260200160008152602001600081526020016000815260200160008152602001606081526020016060815260200160608152602001606081525090565b803573ffffffffffffffffffffffffffffffffffffffff811681146107c157600080fd5b600082601f830112614707578081fd5b813561471a61471582615b14565b615aed565b81815291506020808301908481018184028601820187101561473b57600080fd5b60005b848110156147625761475088836146d3565b8452928201929082019060010161473e565b505050505092915050565b600082601f83011261477d578081fd5b813561478b61471582615b14565b8181529150602080830190840160005b838110156147c8576147b3876020843589010161488b565b8352602092830192919091019060010161479b565b5050505092915050565b600082601f8301126147e2578081fd5b81356147f061471582615b14565b8181529150602080830190840160005b838110156147c8576148188760208435890101614912565b83526020928301929190910190600101614800565b600082601f83011261483d578081fd5b813561484b61471582615b14565b81815291506020808301908481018184028601820187101561486c57600080fd5b60005b848110156147625781358452928201929082019060010161486f565b600082601f83011261489b578081fd5b813567ffffffffffffffff8111156148b1578182fd5b6148e260207fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f84011601615aed565b91508082528360208285010111156148f957600080fd5b8060208401602084013760009082016020015292915050565b60006101c0808385031215614925578182fd5b61492e81615aed565b91505061493b83836146d3565b815261494a83602084016146d3565b602082015261495c83604084016146d3565b604082015261496e83606084016146d3565b60608201526080820135608082015260a082013560a082015260c082013560c082015260e082013560e08201526101008083013581830152506101208083013581830152506101408083013567ffffffffffffffff808211156149d057600080fd5b6149dc8683870161488b565b838501526101609250828501359150808211156149f857600080fd5b614a048683870161488b565b83850152610180925082850135915080821115614a2057600080fd5b614a2c8683870161488b565b838501526101a0925082850135915080821115614a4857600080fd5b50614a558582860161488b565b82840152505092915050565b600060a08284031215614a72578081fd5b614a7c60a0615aed565b90508135815260208201356020820152604082013560408201526060820135614aa481615b88565b6060820152608082013567ffffffffffffffff811115614ac357600080fd5b614acf8482850161488b565b60808301525092915050565b600060208284031215614aec578081fd5b61093283836146d3565b60008060408385031215614b08578081fd5b614b1284846146d3565b9150614b2184602085016146d3565b90509250929050565b60008060408385031215614b3c578182fd5b614b4684846146d3565b915060208301358015158114614b5a578182fd5b809150509250929050565b60008060008060808587031215614b7a578182fd5b843567ffffffffffffffff80821115614b91578384fd5b614b9d8883890161476d565b95506020870135915080821115614bb2578384fd5b614bbe888389016146f7565b94506040870135915080821115614bd3578384fd5b614bdf888389016146f7565b93506060870135915080821115614bf4578283fd5b50614c018782880161482d565b91505092959194509250565b600060208284031215614c1e578081fd5b813567ffffffffffffffff811115614c34578182fd5b610b37848285016147d2565b60008060008060808587031215614c55578182fd5b843567ffffffffffffffff80821115614c6c578384fd5b614c78888389016147d2565b95506020870135915080821115614c8d578384fd5b614c99888389016147d2565b94506040870135915080821115614cae578384fd5b614cba8883890161476d565b93506060870135915080821115614ccf578283fd5b50614c018782880161476d565b600080600060608486031215614cf0578081fd5b833567ffffffffffffffff80821115614d07578283fd5b614d13878388016147d2565b94506020860135915080821115614d28578283fd5b614d348783880161482d565b93506040860135915080821115614d49578283fd5b50614d568682870161476d565b9150509250925092565b600080600060608486031215614d74578081fd5b833567ffffffffffffffff80821115614d8b578283fd5b614d97878388016147d2565b9450602086013593506040860135915080821115614d49578283fd5b60008060408385031215614dc5578182fd5b823567ffffffffffffffff80821115614ddc578384fd5b81850186601f820112614ded578485fd5b80359250614dfd61471584615b14565b83815260208082019190838101885b87811015614e3557614e238c848435890101614a61565b85529382019390820190600101614e0c565b50919750880135945050505080821115614e4d578283fd5b50614e5a8582860161476d565b9150509250929050565b600060208284031215614e75578081fd5b5035919050565b60008060408385031215614e8e578182fd5b823591506020830135614b5a81615b88565b600080600060608486031215614eb4578081fd5b833592506020840135614ec681615b88565b9150604084013567ffffffffffffffff811115614ee1578182fd5b614d568682870161488b565b600060208284031215614efe578081fd5b813561093281615baa565b600060208284031215614f1a578081fd5b815161093281615baa565b600060a0828403128015614f37578182fd5b8015614f41578182fd5b50614f4c60a0615aed565b82518152602083015160208201526040830151604082015260608301516060820152608083015160808201528091505092915050565b600060208284031215614f93578081fd5b813567ffffffffffffffff811115614fa9578182fd5b610b3784828501614912565b60008060408385031215614fc7578182fd5b823567ffffffffffffffff80821115614fde578384fd5b614fea86838701614912565b93506020850135915080821115614fff578283fd5b50614e5a8582860161488b565b60008060008060808587031215615021578182fd5b843567ffffffffffffffff80821115615038578384fd5b61504488838901614912565b95506020870135915080821115615059578384fd5b61506588838901614912565b9450604087013591508082111561507a578384fd5b6150868883890161488b565b9350606087013591508082111561509b578283fd5b50614c018782880161488b565b6000806000606084860312156150bc578081fd5b833567ffffffffffffffff808211156150d3578283fd5b6150df87838801614912565b94506020860135935060408601359150808211156150fb578283fd5b50614d568682870161488b565b6000806040838503121561511a578182fd5b823567ffffffffffffffff80821115615131578384fd5b614fea86838701614a61565b73ffffffffffffffffffffffffffffffffffffffff169052565b6000815180845260208401935060208301825b828110156151935761517d8683516151e7565b60a095909501946020919091019060010161516a565b5093949350505050565b600081518084526151b5816020860160208601615b34565b601f017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0169290920160200192915050565b80518252602081015160208301526040810151604083015260608101516060830152608081015160808301525050565b60006101c061522784845161513d565b6020830151615239602086018261513d565b50604083015161524c604086018261513d565b50606083015161525f606086018261513d565b506080830151608085015260a083015160a085015260c083015160c085015260e083015160e08501526101008084015181860152506101208084015181860152506101408084015182828701526152b88387018261519d565b915050610160915081840151858203838701526152d5828261519d565b9250505061018080840151858303828701526152f1838261519d565b9150506101a091508184015185820383870152613de2828261519d565b60008251615320818460208701615b34565b9190910192915050565b7f19457468657265756d205369676e6564204d6573736167653a0a3332000000008152601c810191909152603c0190565b73ffffffffffffffffffffffffffffffffffffffff91909116815260200190565b73ffffffffffffffffffffffffffffffffffffffff92831681529116602082015260400190565b73ffffffffffffffffffffffffffffffffffffffff9384168152919092166020820152604081019190915260600190565b600073ffffffffffffffffffffffffffffffffffffffff8616825260806020830152615403608083018661519d565b8281036040840152615415818661519d565b8381036060850152615427818661519d565b98975050505050505050565b6000602080830181845280855180835260408601915060408482028701019250838701855b828110156154a4577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc088860301845261549285835161519d565b94509285019290850190600101615458565b5092979650505050505050565b6000602082526109326020830184615157565b901515815260200190565b90815260200190565b91825273ffffffffffffffffffffffffffffffffffffffff16602082015260400190565b600085825273ffffffffffffffffffffffffffffffffffffffff8516602083015260806040830152615531608083018561519d565b82810360608401526138a9818561519d565b918252602082015260400190565b600083825260406020830152610b37604083018461519d565b600084825260606020830152615583606083018561519d565b8281036040840152613de2818561519d565b828152604081016155a583615b7e565b8260208301529392505050565b600086825285602083015273ffffffffffffffffffffffffffffffffffffffff808616604084015280851660608401525060a060808301526138a960a083018461519d565b9283526020830191909152604082015260600190565b93845260ff9290921660208401526040830152606082015260800190565b7fffffffff0000000000000000000000000000000000000000000000000000000091909116815260200190565b7fffffffff0000000000000000000000000000000000000000000000000000000092909216825273ffffffffffffffffffffffffffffffffffffffff16602082015260400190565b600060208252610932602083018461519d565b6000608082526156c6608083018761519d565b73ffffffffffffffffffffffffffffffffffffffff95861660208401529390941660408201526060015292915050565b600060408252615709604083018561519d565b8281036020840152610de6818561519d565b60006060825261572e606083018661519d565b8281036020840152615740818661519d565b91505073ffffffffffffffffffffffffffffffffffffffff83166040830152949350505050565b600061016080835261577b8184018f61519d565b838103602085015261578d818f61519d565b91505082810360408401526157a2818d61519d565b83810360608501526157b4818d61519d565b73ffffffffffffffffffffffffffffffffffffffff9b8c16608086015299909a1660a0840152505060c081019590955260e08501939093526101008401919091526101208301526101409091015295945050505050565b600061581685615b60565b84825283602083015260606040830152610de6606083018461519d565b6020810161584083615b6a565b91905290565b6060810161585385615b6a565b938152602081019290925260409091015290565b6060810161587485615b74565b938152602081019290925273ffffffffffffffffffffffffffffffffffffffff1660409091015290565b6060810161585385615b74565b606081016008851061585357fe5b60006158c486615b7e565b85825284602083015273ffffffffffffffffffffffffffffffffffffffff8416604083015260806060830152613de2608083018461519d565b6040810161590a84615b60565b9281526020015290565b60208082526014908201527f5452414e53464552535f5355434345535346554c000000000000000000000000604082015260600190565b60006020825282516080602084015261596760a0840182615157565b602085015191507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08482030160408501526159a28183615157565b604086015160608601526060860151608086015280935050505092915050565b60a081016107c182846151e7565b6000610180820190506159e48284516151e7565b60208301516159f660a08401826151e7565b5060408301516101408301526060909201516101609091015290565b815160ff168152602080830151908201526040918201519181019190915260600190565b600060408252615a496040830185615217565b90508260208301529392505050565b600060608252615a6b6060830186615217565b8460208401528281036040840152613de2818561519d565b60006040825283516040830152602084015160608301526040840151608083015273ffffffffffffffffffffffffffffffffffffffff60608501511660a0830152608084015160a060c0840152615add60e084018261519d565b9150508260208301529392505050565b60405181810167ffffffffffffffff81118282101715615b0c57600080fd5b604052919050565b600067ffffffffffffffff821115615b2a578081fd5b5060209081020190565b60005b83811015615b4f578181015183820152602001615b37565b838111156133265750506000910152565b6002811061080f57fe5b6004811061080f57fe5b6003811061080f57fe5b6007811061080f57fe5b73ffffffffffffffffffffffffffffffffffffffff8116811461080f57600080fd5b7fffffffff000000000000000000000000000000000000000000000000000000008116811461080f57600080fd5b8351602094850120835193850193909320604080517f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f815295860194909452928401929092526060830152608082015260a090209056fea365627a7a723158206fc97c5a1d6fde6b2ada9eb4429966e52d7e2da39180893c04bf55c840b346a16c6578706572696d656e74616cf564736f6c634300050c0040" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:110](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L110)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:13398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13398)* + +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:13356](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13356)* + +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:13381](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13381)* + +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:13387](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13387)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10467](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10467)* + +**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:10420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10420)* + +**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:10394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10394)* + +**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:112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L112)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L118)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:182](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L182)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L170)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:160](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L160)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### EIP712_EXCHANGE_DOMAIN_HASH + +#### ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:190](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L190)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:196](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L196)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:260](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L260)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:248](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L248)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:238](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L238)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### allowedValidators + +#### ▪ **allowedValidators**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:268](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L268)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:274](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.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 | - | +`index_1` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:353](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L353)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L341)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:326](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L326)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### batchCancelOrders + +#### ▪ **batchCancelOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:364](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L364)* + +Executes multiple calls of cancelOrder. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L420)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:531](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L531)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:462](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L462)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:682](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L682)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:630](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L630)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`Array`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:599](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L599)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:372](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L372)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:502](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L502)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchExecuteTransactions + +#### ▪ **batchExecuteTransactions**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:695](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L695)* + +Executes a batch of Exchange method calls in the context of signer(s). + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:748](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L748)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`transactions`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:846](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.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 | +------ | ------ | ------ | ------ | +`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:785](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L785)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:963](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L963)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:933](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L933)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactions`: `Array`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:909](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L909)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:705](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L705)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:818](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L818)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transactions` | `Array` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchFillOrKillOrders + +#### ▪ **batchFillOrKillOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:976](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L976)* + +Executes multiple calls of fillOrKillOrder. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1042](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1042)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1180](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1180)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1096](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1096)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1354](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1354)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`Array`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1306](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1306)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1271](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1271)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:987](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L987)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1140](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1140)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmounts` | `BigNumber`[] | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchFillOrders + +#### ▪ **batchFillOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1383](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1383)* + +Executes multiple calls of fillOrder. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1449)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1587](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1587)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1503](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1503)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1761](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1761)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`Array`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1713](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1713)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1678](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1678)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1394)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1547](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1547)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmounts` | `BigNumber`[] | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchFillOrdersNoThrow + +#### ▪ **batchFillOrdersNoThrow**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1790](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1790)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1856](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1856)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1994](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1994)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`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:1910](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1910)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2168)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`Array`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2120)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2085](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2085)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1801](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1801)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1954](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1954)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmounts` | `BigNumber`[] | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchMatchOrders + +#### ▪ **batchMatchOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2199](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2199)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2286](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2286)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2486](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2486)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:2360](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2360)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2714](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2714)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2666](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2666)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2614](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2614)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2212)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2421](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2421)* + +**Parameters:** + +Name | Type | +------ | ------ | +`leftOrders` | `Array` | +`rightOrders` | `Array` | +`leftSignatures` | string[] | +`rightSignatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchMatchOrdersWithMaximalFill + +#### ▪ **batchMatchOrdersWithMaximalFill**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2766](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2766)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2853](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2853)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3053](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3053)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:2927](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2927)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3281](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3281)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3233](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3233)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3181)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2779](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2779)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2988](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2988)* + +**Parameters:** + +Name | Type | +------ | ------ | +`leftOrders` | `Array` | +`rightOrders` | `Array` | +`leftSignatures` | string[] | +`rightSignatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### cancelOrder + +#### ▪ **cancelOrder**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3330)* + +After calling, the order can not be filled anymore. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3385](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3385)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3494](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3494)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:3426](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3426)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3641)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3589](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3589)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[object]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3561)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3338](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3338)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3465](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3465)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### cancelOrdersUpTo + +#### ▪ **cancelOrdersUpTo**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3655)* + +Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch +and senderAddress equal to msg.sender (or null address if msg.sender == makerAddress). + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3692](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3692)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`targetOrderEpoch`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3754](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3754)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:3720](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3720)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3828](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3828)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3816](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3816)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`targetOrderEpoch`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3803)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3664](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3664)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3739](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3739)* + +**Parameters:** + +Name | Type | +------ | ------ | +`targetOrderEpoch` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### cancelled + +#### ▪ **cancelled**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3836](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3836)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3842](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3842)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3912](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3912)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3900](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3900)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3889](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3889)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### currentContextAddress + +#### ▪ **currentContextAddress**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3920](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3920)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3926](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3926)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3990](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3990)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3978](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3978)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3968](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3968)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### executeTransaction + +#### ▪ **executeTransaction**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4001](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4001)* + +Executes an Exchange method call in the context of signer. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4051](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4051)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction structure. | +`signature` | string | Proof that transaction has been signed by signer. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`transaction`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4141)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:4086](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4086)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4253](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4253)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4225](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4225)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transaction`: object, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4202](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4202)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4010](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4010)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction 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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4118)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transaction` | object | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### fillOrKillOrder + +#### ▪ **fillOrKillOrder**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4266](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4266)* + +Fills the input order. Reverts if exact takerAssetFillAmount not filled. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4329)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4462](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4462)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:4381](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4381)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4627](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4627)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4581](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4581)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4547](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4547)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4276](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4276)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4424](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4424)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAssetFillAmount` | `BigNumber` | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### fillOrder + +#### ▪ **fillOrder**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4654](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4654)* + +Fills the input order. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4717](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4717)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4846](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4846)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:4764](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4764)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5011](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5011)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4965](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4965)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4931](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4931)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4664](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4664)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4807](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4807)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAssetFillAmount` | `BigNumber` | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### filled + +#### ▪ **filled**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5035](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5035)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5041](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5041)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5111)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5099](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5099)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5088](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5088)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getAssetProxy + +#### ▪ **getAssetProxy**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5122)* + +Gets an asset proxy. + +#### callAsync + +▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5130)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`assetProxyId` | string | - | Id of the asset proxy. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5201](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5201)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5189](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5189)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetProxyId`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5178](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5178)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxyId` | string | Id of the asset proxy. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getOrderInfo + +#### ▪ **getOrderInfo**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5212)* + +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:5220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5220)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`order` | object | - | Order to gather information on. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +OrderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5365](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5365)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5319](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5319)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5291](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5291)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order to gather information on. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### isValidHashSignature + +#### ▪ **isValidHashSignature**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5384](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5384)* + +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:5394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5394)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5480)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5468)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5452](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5452)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32-byte hash. | +`signerAddress` | string | Address that should have signed the given hash. | +`signature` | string | Proof that the hash has been signed by signer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### isValidOrderSignature + +#### ▪ **isValidOrderSignature**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5491](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5491)* + +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:5500](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5500)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5648](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5648)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5602](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5602)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5570](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5570)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The order. | +`signature` | string | Proof that the order has been signed by signer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### isValidTransactionSignature + +#### ▪ **isValidTransactionSignature**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5661](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5661)* + +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:5670](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5670)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5782](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5782)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5754](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5754)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transaction`: object, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5731](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5731)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | The transaction. | +`signature` | string | Proof that the order has been signed by signer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### marketBuyOrdersFillOrKill + +#### ▪ **marketBuyOrdersFillOrKill**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5796](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5796)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5860](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5860)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Minimum amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5996](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5996)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:5913](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5913)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6165](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6165)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6117)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6082](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6082)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5806](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5806)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | 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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5957](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5957)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`makerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### marketBuyOrdersNoThrow + +#### ▪ **marketBuyOrdersNoThrow**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6194)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6258](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6258)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6394)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:6311](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6311)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6563](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6563)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6515](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6515)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6480)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6204](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6204)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6355)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`makerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### marketSellOrdersFillOrKill + +#### ▪ **marketSellOrdersFillOrKill**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6591](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6591)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6655)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Minimum amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6791](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6791)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:6708](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6708)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6960](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6960)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6912](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6912)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6877](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6877)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6601](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6601)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | 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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6752](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6752)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### marketSellOrdersNoThrow + +#### ▪ **marketSellOrdersNoThrow**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6989](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6989)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7053](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7053)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7189](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7189)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:7106](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7106)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7358)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7310](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7310)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7275](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7275)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6999](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6999)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7150](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7150)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### matchOrders + +#### ▪ **matchOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7388](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7388)* + +Match two complementary orders that have a profitable spread. +Each order is filled at their respective price point. However, the calculations are +carried out as though the orders are both being filled at the right order's price point. +The profit made by the left order goes to the taker (who matched the two orders). + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7469](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7469)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7655)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:7539](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7539)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7875](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7875)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7829](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7829)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7779](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7779)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7399](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7399)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7598](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7598)* + +**Parameters:** + +Name | Type | +------ | ------ | +`leftOrder` | object | +`rightOrder` | object | +`leftSignature` | string | +`rightSignature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### matchOrdersWithMaximalFill + +#### ▪ **matchOrdersWithMaximalFill**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7927](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7927)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8008](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8008)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8200](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8200)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:8078](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8078)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8420)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8374](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8374)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8324](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8324)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7938](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7938)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8137)* + +**Parameters:** + +Name | Type | +------ | ------ | +`leftOrder` | object | +`rightOrder` | object | +`leftSignature` | string | +`rightSignature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### orderEpoch + +#### ▪ **orderEpoch**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8466](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8466)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8472](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8472)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`index_1` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8551](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8551)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8539](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8539)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8524](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8524)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### owner + +#### ▪ **owner**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8559](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8559)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8565](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8565)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8629](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8629)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8617)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8607](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8607)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### preSign + +#### ▪ **preSign**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8641)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8676)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32-byte hash. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`hash`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8733](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8733)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:8703](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8703)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8800](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8800)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8788](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8788)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8777](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8777)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`hash`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8649](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8649)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32-byte hash. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`hash`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8722](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8722)* + +**Parameters:** + +Name | Type | +------ | ------ | +`hash` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### preSigned + +#### ▪ **preSigned**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8808](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8808)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8814](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8814)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`index_1` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8893](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8893)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8881](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8881)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8866](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8866)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### protocolFeeCollector + +#### ▪ **protocolFeeCollector**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8901](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8901)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8907](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8907)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8971](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8971)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8959](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8959)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8949](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8949)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +___ + +### protocolFeeMultiplier + +#### ▪ **protocolFeeMultiplier**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8979](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8979)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8985](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8985)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9049](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9049)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9037](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9037)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9027](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9027)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +___ + +### registerAssetProxy + +#### ▪ **registerAssetProxy**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9061](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9061)* + +Registers an asset proxy to its asset proxy id. +Once an asset proxy is registered, it cannot be unregistered. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`assetProxy`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9096](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9096)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxy` | string | Address of new asset proxy to register. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`assetProxy`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9156](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9156)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9123](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9123)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxy` | string | Address of new asset proxy to register. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9229)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9217)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9204](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9204)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxy` | string | Address of new asset proxy to register. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9069](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9069)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxy` | string | Address of new asset proxy to register. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9142](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9142)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetProxy` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### setProtocolFeeCollectorAddress + +#### ▪ **setProtocolFeeCollectorAddress**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9240](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9240)* + +Allows the owner to update the protocolFeeCollector address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9282](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9282)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`updatedProtocolFeeCollector`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9355)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9313](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9313)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9431)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9419](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9419)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`updatedProtocolFeeCollector`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9406](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9406)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9249](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9249)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9337](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9337)* + +**Parameters:** + +Name | Type | +------ | ------ | +`updatedProtocolFeeCollector` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### setProtocolFeeMultiplier + +#### ▪ **setProtocolFeeMultiplier**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9442)* + +Allows the owner to update the protocol fee multiplier. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9482](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9482)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9553](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9553)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9512](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9512)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9628)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9616](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9616)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`updatedProtocolFeeMultiplier`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9603](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9603)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9450](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9450)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9536](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9536)* + +**Parameters:** + +Name | Type | +------ | ------ | +`updatedProtocolFeeMultiplier` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### setSignatureValidatorApproval + +#### ▪ **setSignatureValidatorApproval**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9640](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9640)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9685](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9685)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`validatorAddress`: string, `approval`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9766](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9766)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9719](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9719)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9847](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9847)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9835](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9835)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, boolean]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`validatorAddress`: string, `approval`: boolean): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9820](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9820)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9649](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9649)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9746](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9746)* + +**Parameters:** + +Name | Type | +------ | ------ | +`validatorAddress` | string | +`approval` | boolean | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### simulateDispatchTransferFromCalls + +#### ▪ **simulateDispatchTransferFromCalls**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9858](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9858)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9919](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9919)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string[] | 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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10033](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10033)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9965](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9965)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10135)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string[], string[], string[], `BigNumber`[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10121)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string[], string[], string[], `BigNumber`[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10099](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10099)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9873](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9873)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string[] | 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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9996](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9996)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetData` | string[] | +`fromAddresses` | string[] | +`toAddresses` | string[] | +`amounts` | `BigNumber`[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transactionsExecuted + +#### ▪ **transactionsExecuted**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10145](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10145)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10151](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10151)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10221](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10221)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10209)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10198](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10198)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transferOwnership + +#### ▪ **transferOwnership**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10229)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10262](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10262)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10317](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10317)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:10288](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10288)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10385](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10385)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10373](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10373)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10360](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10360)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10236](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10236)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10307](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10307)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# 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:238](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L238)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | IValidatorContract.deployedBytecode | + +**Returns:** *[IValidatorContract](#class-ivalidatorcontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string | undefined* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L31)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:207](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L207)* + +**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:165](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L165)* + +**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:140](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L140)* + +**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:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L35)* + +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:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L45)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`hash` | string | - | Message hash that is signed. | +`signerAddress` | string | - | Address that should have signed the given hash. | +`signature` | string | - | Proof of signing. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256("isValidValidatorSignature(address,bytes32,address,bytes)")) + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:132](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L132)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L120)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L103)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Message hash that is signed. | +`signerAddress` | string | Address that should have signed the given hash. | +`signature` | string | Proof of signing. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +
+ +# Class: IWalletContract + + +## Constructors + + + +\+ **new IWalletContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IWalletContract](#class-iwalletcontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:224](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L224)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | IWalletContract.deployedBytecode | + +**Returns:** *[IWalletContract](#class-iwalletcontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string | undefined* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L31)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L197)* + +**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:155](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L155)* + +**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:130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L130)* + +**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:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L35)* + +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:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L44)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`hash` | string | - | Message hash that is signed. | +`signature` | string | - | Proof of signing. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +magicValue `bytes4(0xb0671381)` if the signature check succeeds. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L122)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:110](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L110)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L95)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Message hash that is signed. | +`signature` | string | Proof of signing. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +
+ +# Class: 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:1877](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1877)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | WETH9Contract.deployedBytecode | + +**Returns:** *[WETH9Contract](#class-weth9contract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x6080604052600436106100925760003560e01c63ffffffff16806306fdde031461009c578063095ea7b31461012657806318160ddd1461016b57806323b872dd146101925780632e1a7d4d146101c9578063313ce567146101e157806370a082311461020c57806395d89b411461023a578063a9059cbb1461024f578063d0e30db014610092578063dd62ed3e14610280575b61009a6102b4565b005b3480156100a857600080fd5b506100b1610303565b6040805160208082528351818301528351919283929083019185019080838360005b838110156100eb5781810151838201526020016100d3565b50505050905090810190601f1680156101185780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561013257600080fd5b5061015773ffffffffffffffffffffffffffffffffffffffff600435166024356103af565b604080519115158252519081900360200190f35b34801561017757600080fd5b50610180610422565b60408051918252519081900360200190f35b34801561019e57600080fd5b5061015773ffffffffffffffffffffffffffffffffffffffff60043581169060243516604435610427565b3480156101d557600080fd5b5061009a6004356105c7565b3480156101ed57600080fd5b506101f661065c565b6040805160ff9092168252519081900360200190f35b34801561021857600080fd5b5061018073ffffffffffffffffffffffffffffffffffffffff60043516610665565b34801561024657600080fd5b506100b1610677565b34801561025b57600080fd5b5061015773ffffffffffffffffffffffffffffffffffffffff600435166024356106ef565b34801561028c57600080fd5b5061018073ffffffffffffffffffffffffffffffffffffffff60043581169060243516610703565b33600081815260036020908152604091829020805434908101909155825190815291517fe1fffcc4923d04b559f4d29a8bfc6cda04eb5b0d3c460751c2402c5c5cc9109c9281900390910190a2565b6000805460408051602060026001851615610100027fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190941693909304601f810184900484028201840190925281815292918301828280156103a75780601f1061037c576101008083540402835291602001916103a7565b820191906000526020600020905b81548152906001019060200180831161038a57829003601f168201915b505050505081565b33600081815260046020908152604080832073ffffffffffffffffffffffffffffffffffffffff8716808552908352818420869055815186815291519394909390927f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925928290030190a350600192915050565b303190565b73ffffffffffffffffffffffffffffffffffffffff831660009081526003602052604081205482111561045957600080fd5b73ffffffffffffffffffffffffffffffffffffffff841633148015906104cf575073ffffffffffffffffffffffffffffffffffffffff841660009081526004602090815260408083203384529091529020547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff14155b156105495773ffffffffffffffffffffffffffffffffffffffff8416600090815260046020908152604080832033845290915290205482111561051157600080fd5b73ffffffffffffffffffffffffffffffffffffffff841660009081526004602090815260408083203384529091529020805483900390555b73ffffffffffffffffffffffffffffffffffffffff808516600081815260036020908152604080832080548890039055938716808352918490208054870190558351868152935191937fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef929081900390910190a35060019392505050565b336000908152600360205260409020548111156105e357600080fd5b33600081815260036020526040808220805485900390555183156108fc0291849190818181858888f19350505050158015610622573d6000803e3d6000fd5b5060408051828152905133917f7fcf532c15f0a6db0bd6d0e038bea71d30d808c7d98cb3bf7268a95bf5081b65919081900360200190a250565b60025460ff1681565b60036020526000908152604090205481565b60018054604080516020600284861615610100027fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190941693909304601f810184900484028201840190925281815292918301828280156103a75780601f1061037c576101008083540402835291602001916103a7565b60006106fc338484610427565b9392505050565b6004602090815260009283526040808420909152908252902054815600a165627a7a723058201ebe888a6b56dd871f599adbe0f19ec3c29c28aec0685788dfac9b37a99fc9d20029" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:67](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L67)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1861](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1861)* + +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:1819](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1819)* + +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:1844](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1844)* + +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:1850](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1850)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1522](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1522)* + +**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:1480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1480)* + +**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:1455](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1455)* + +**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:1361](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1361)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1367](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1367)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`index_1` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1446](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1446)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1434)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1419](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1419)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### approve + +#### ▪ **approve**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:147](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L147)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L181)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`guy` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`guy`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:243](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L243)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`guy` | string | - | +`wad` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L209)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`guy` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:319](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L319)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:307](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L307)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`guy`: string, `wad`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:292](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L292)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`guy` | string | +`wad` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:154](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L154)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`guy` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L229)* + +**Parameters:** + +Name | Type | +------ | ------ | +`guy` | string | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:861](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L861)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:867](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L867)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:939](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L939)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:927](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L927)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:914](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L914)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decimals + +#### ▪ **decimals**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:783](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L783)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:789](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L789)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:853](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L853)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *number* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:841](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L841)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:831](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L831)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### deposit + +#### ▪ **deposit**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1205](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1205)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1237](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1237)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1289)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1261](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1261)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1353](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1353)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1341)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1331)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1212)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1279](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1279)* + +**Parameters:** + +Name | Type | +------ | ------ | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### name + +#### ▪ **name**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:69](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L69)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L75)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:139](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L139)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:127](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L127)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.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). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### symbol + +#### ▪ **symbol**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:947](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L947)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:953](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L953)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1017](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1017)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1005](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1005)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:995](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L995)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### totalSupply + +#### ▪ **totalSupply**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:327](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L327)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:333](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L333)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:397](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L397)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:385](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L385)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:375](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L375)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transfer + +#### ▪ **transfer**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1025](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1025)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1059](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1059)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1121)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1087](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1087)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1197)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1185](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1185)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`dst`: string, `wad`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.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 | +------ | ------ | +`dst` | string | +`wad` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1032](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1032)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1107](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1107)* + +**Parameters:** + +Name | Type | +------ | ------ | +`dst` | string | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:405](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L405)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L449)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`src` | string | - | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:529](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L529)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:484](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L484)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`src` | string | - | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:613](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L613)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:601](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L601)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`src`: string, `dst`: string, `wad`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:584](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L584)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`src` | string | +`dst` | string | +`wad` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:412](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L412)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`src` | string | - | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:514](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L514)* + +**Parameters:** + +Name | Type | +------ | ------ | +`src` | string | +`dst` | string | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### withdraw + +#### ▪ **withdraw**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:621](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L621)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:654](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L654)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`wad` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:709](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L709)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:680](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L680)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:775](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L775)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:763](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L763)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`wad`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:752](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L752)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`wad` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L628)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:699](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L699)* + +**Parameters:** + +Name | Type | +------ | ------ | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ZRXTokenContract + + +## Constructors + + + +\+ **new ZRXTokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ZRXTokenContract](#class-zrxtokencontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1512](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1512)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ZRXTokenContract.deployedBytecode | + +**Returns:** *[ZRXTokenContract](#class-zrxtokencontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x606060405236156100965763ffffffff7c010000000000000000000000000000000000000000000000000000000060003504166306fdde038114610098578063095ea7b31461014657806318160ddd1461018657806323b872dd146101a8578063313ce567146101ee57806370a082311461021457806395d89b411461024f578063a9059cbb146102fd578063dd62ed3e1461033d575bfe5b34156100a057fe5b6100a861037e565b60408051602080825283518183015283519192839290830191850190808383821561010c575b80518252602083111561010c577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe090920191602091820191016100ce565b505050905090810190601f1680156101385780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b341561014e57fe5b61017273ffffffffffffffffffffffffffffffffffffffff600435166024356103b5565b604080519115158252519081900360200190f35b341561018e57fe5b61019661042d565b60408051918252519081900360200190f35b34156101b057fe5b61017273ffffffffffffffffffffffffffffffffffffffff60043581169060243516604435610433565b604080519115158252519081900360200190f35b34156101f657fe5b6101fe6105d4565b6040805160ff9092168252519081900360200190f35b341561021c57fe5b61019673ffffffffffffffffffffffffffffffffffffffff600435166105d9565b60408051918252519081900360200190f35b341561025757fe5b6100a8610605565b60408051602080825283518183015283519192839290830191850190808383821561010c575b80518252602083111561010c577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe090920191602091820191016100ce565b505050905090810190601f1680156101385780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b341561030557fe5b61017273ffffffffffffffffffffffffffffffffffffffff6004351660243561063c565b604080519115158252519081900360200190f35b341561034557fe5b61019673ffffffffffffffffffffffffffffffffffffffff60043581169060243516610727565b60408051918252519081900360200190f35b60408051808201909152601181527f30782050726f746f636f6c20546f6b656e000000000000000000000000000000602082015281565b73ffffffffffffffffffffffffffffffffffffffff338116600081815260016020908152604080832094871680845294825280832086905580518681529051929493927f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925929181900390910190a35060015b92915050565b60035481565b73ffffffffffffffffffffffffffffffffffffffff808416600081815260016020908152604080832033909516835293815283822054928252819052918220548390108015906104835750828110155b80156104b6575073ffffffffffffffffffffffffffffffffffffffff841660009081526020819052604090205483810110155b156105c65773ffffffffffffffffffffffffffffffffffffffff808516600090815260208190526040808220805487019055918716815220805484900390557fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8110156105585773ffffffffffffffffffffffffffffffffffffffff808616600090815260016020908152604080832033909416835292905220805484900390555b8373ffffffffffffffffffffffffffffffffffffffff168573ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef856040518082815260200191505060405180910390a3600191506105cb565b600091505b5b509392505050565b601281565b73ffffffffffffffffffffffffffffffffffffffff81166000908152602081905260409020545b919050565b60408051808201909152600381527f5a52580000000000000000000000000000000000000000000000000000000000602082015281565b73ffffffffffffffffffffffffffffffffffffffff3316600090815260208190526040812054829010801590610699575073ffffffffffffffffffffffffffffffffffffffff831660009081526020819052604090205482810110155b156107185773ffffffffffffffffffffffffffffffffffffffff33811660008181526020818152604080832080548890039055938716808352918490208054870190558351868152935191937fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef929081900390910190a3506001610427565b506000610427565b5b92915050565b73ffffffffffffffffffffffffffffffffffffffff8083166000908152600160209081526040808320938516835292905220545b929150505600a165627a7a72305820d984298155c708a8164f1cbf83c7275bcc6851dd082c0404013c1f4463b238fa0029" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L51)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1496](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1496)* + +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:1454](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1454)* + +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:1479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1479)* + +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:1485](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1485)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1226](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1226)* + +**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:1184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1184)* + +**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:1159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1159)* + +**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/zrx_token.ts:1065](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1065)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1071](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1071)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`_owner` | string | - | +`_spender` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1150](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1150)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1138](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1138)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1123](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1123)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`_owner` | string | +`_spender` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### approve + +#### ▪ **approve**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L131)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:172](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L172)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:241](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L241)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`_spender` | string | - | +`_value` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:200](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L200)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:320](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L320)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:308](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L308)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:293](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L293)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:138](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L138)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:227](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L227)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:719](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L719)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:725](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L725)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`_owner` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:795](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L795)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:783](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L783)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:772](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L772)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`_owner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decimals + +#### ▪ **decimals**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L641)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:647](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L647)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:711](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L711)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *number* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:699](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L699)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L689)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### name + +#### ▪ **name**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L53)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L59)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:123](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L123)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L111)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:101](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L101)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### symbol + +#### ▪ **symbol**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L803)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:809](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L809)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:873](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L873)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:861](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L861)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:851](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L851)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### totalSupply + +#### ▪ **totalSupply**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L328)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:334](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L334)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L398)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:386](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L386)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:376](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L376)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transfer + +#### ▪ **transfer**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:881](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L881)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:919](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L919)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:981](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L981)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`_to` | string | - | +`_value` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:947](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L947)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1057](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1057)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1045](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1045)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1030](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.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 | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:888](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L888)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:967](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L967)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:409](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L409)* + +ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:459](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L459)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:546](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L546)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_from` | string | - | Address to transfer from. | +`_to` | string | - | Address to transfer to. | +`_value` | `BigNumber` | - | Amount to transfer. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Success of transfer. + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:497](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L497)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:633](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L633)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:621](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L621)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:604](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L604)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:419](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L419)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:527](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L527)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: MetamaskSubprovider + +This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) +subprovider interface and the provider sendAsync interface. +It handles inconsistencies with Metamask implementations of various JSON RPC methods. +It forwards JSON RPC requests involving the domain of a signer (getAccounts, +sendTransaction, signMessage etc...) to the provider instance supplied at instantiation. All other requests +are passed onwards for subsequent subproviders to handle. + + +## Constructors + + + +\+ **new MetamaskSubprovider**(`supportedProvider`: [SupportedProvider](#supportedprovider)): *[MetamaskSubprovider](#class-metamasksubprovider)* + +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* + +Instantiates a new MetamaskSubprovider + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider that should handle all user account related requests | + +**Returns:** *[MetamaskSubprovider](#class-metamasksubprovider)* + +## Methods + +#### emitPayloadAsync + +▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* + + + +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/subprovider.ts#L55)* + +Emits a JSON RPC payload that will then be handled by the ProviderEngine instance +this subprovider is a part of. The payload will cascade down the subprovider middleware +stack until finding the responsible entity for handling the request. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`payload` | `Partial` | JSON RPC payload | + +**Returns:** *`Promise`* + +JSON RPC response payload + +___ + +### handleRequest + +▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* + +*Overrides void* + +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/metamask_subprovider.ts#L39)* + +This method conforms to the web3-provider-engine interface. +It is called internally by the ProviderEngine when it is this subproviders +turn to handle a JSON RPC request. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`payload` | `JSONRPCRequestPayload` | JSON RPC payload | +`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | +`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | + +**Returns:** *`Promise`* + +___ + +### sendAsync + +▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* + +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/metamask_subprovider.ts#L117)* + +This method conforms to the provider sendAsync interface. +Allowing the MetamaskSubprovider to be used as a generic provider (outside of Web3ProviderEngine) with the +addition of wrapping the inconsistent Metamask behaviour + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`payload` | `JSONRPCRequestPayload` | JSON RPC payload | +`callback` | [ErrorCallback](#errorcallback) | - | + +**Returns:** *void* + +The contents nested under the result key of the response body + +___ + +### setEngine + +▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* + + + +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/subprovider.ts#L68)* + +Set's the subprovider's engine to the ProviderEngine it is added to. +This is only called within the ProviderEngine source code, do not call +directly. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | + +**Returns:** *void* + +
+ +# Class: RPCSubprovider + +This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. +It forwards on JSON RPC requests to the supplied `rpcUrl` endpoint + + +## Constructors + + + +\+ **new RPCSubprovider**(`rpcUrl`: string, `requestTimeoutMs`: number): *[RPCSubprovider](#class-rpcsubprovider)* + +*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`rpcUrl` | string | - | URL to the backing Ethereum node to which JSON RPC requests should be sent | +`requestTimeoutMs` | number | 20000 | Amount of miliseconds to wait before timing out the JSON RPC request | + +**Returns:** *[RPCSubprovider](#class-rpcsubprovider)* + +## Methods + +### emitPayloadAsync + +▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* + + + +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/subprovider.ts#L55)* + +Emits a JSON RPC payload that will then be handled by the ProviderEngine instance +this subprovider is a part of. The payload will cascade down the subprovider middleware +stack until finding the responsible entity for handling the request. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`payload` | `Partial` | JSON RPC payload | + +**Returns:** *`Promise`* + +JSON RPC response payload + +___ + +### handleRequest + +▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `_next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* + +*Overrides void* + +*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* + +This method conforms to the web3-provider-engine interface. +It is called internally by the ProviderEngine when it is this subproviders +turn to handle a JSON RPC request. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`payload` | `JSONRPCRequestPayload` | JSON RPC payload | +`_next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | +`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | + +**Returns:** *`Promise`* + +___ + +### setEngine + +▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* + + + +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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* + +
+ +# Enumeration: ERC20TokenEvents + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L32)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L31)* + +
+ +# Enumeration: ERC721TokenEvents + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L34)* + +___ + +### ApprovalForAll + +• **ApprovalForAll**: = "ApprovalForAll" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L35)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L36)* + +
+ +# Enumeration: ExchangeEvents + + +## Enumeration members + +### AssetProxyRegistered + +• **AssetProxyRegistered**: = "AssetProxyRegistered" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L39)* + +___ + +### Cancel + +• **Cancel**: = "Cancel" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L40)* + +___ + +### CancelUpTo + +• **CancelUpTo**: = "CancelUpTo" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L41)* + +___ + +### Fill + +• **Fill**: = "Fill" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L42)* + +___ + +### ProtocolFeeCollectorAddress + +• **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L43)* + +___ + +### ProtocolFeeMultiplier + +• **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L44)* + +___ + +### SignatureValidatorApproval + +• **SignatureValidatorApproval**: = "SignatureValidatorApproval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L45)* + +___ + +### TransactionExecution + +• **TransactionExecution**: = "TransactionExecution" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L46)* + +
+ +# Enumeration: WETH9Events + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L35)* + +___ + +### Deposit + +• **Deposit**: = "Deposit" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L37)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L36)* + +___ + +### Withdrawal + +• **Withdrawal**: = "Withdrawal" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L38)* + +
+ +# Enumeration: ZRXTokenEvents + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L32)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L31)* + +
+ +# Enumeration: NetworkId + + +## Enumeration members + +### Ganache + +• **Ganache**: = 50 + +*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L26)* + +___ + +### Kovan + +• **Kovan**: = 42 + +*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L25)* + +___ + +### Mainnet + +• **Mainnet**: = 1 + +*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L22)* + +___ + +### Rinkeby + +• **Rinkeby**: = 4 + +*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L24)* + +___ + +### Ropsten + +• **Ropsten**: = 3 + +*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L23)* + +
+ + + +# Enumeration: BlockParamLiteral + + +## Enumeration members + +### Earliest + +• **Earliest**: = "earliest" + +*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L478)* + +___ + +### Latest + +• **Latest**: = "latest" + +*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L479)* + +___ + +### Pending + +• **Pending**: = "pending" + +*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L480)* + +
+ + + + + + + + + + + +# Enumeration: AssetProxyId + + +## Enumeration members + +### ERC1155 + +• **ERC1155**: = "0xa7cb5fb7" + +*Defined in [types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L166)* + +___ + +### ERC20 + +• **ERC20**: = "0xf47261b0" + +*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L163)* + +___ + +### ERC20Bridge + +• **ERC20Bridge**: = "0xdc1600f3" + +*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L168)* + +___ + +### ERC721 + +• **ERC721**: = "0x02571792" + +*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L164)* + +___ + +### MultiAsset + +• **MultiAsset**: = "0x94cfcdd7" + +*Defined in [types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L165)* + +___ + +### StaticCall + +• **StaticCall**: = "0xc339d10a" + +*Defined in [types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L167)* +
@@ -12406,6 +15842,82 @@ The amount of the asset tranferable by the owner. NOTE: If the `assetData&# +# Enumeration: SignatureType + + +## Enumeration members + +### EIP1271Wallet + +• **EIP1271Wallet**: + +*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L158)* + +___ + +### EIP712 + +• **EIP712**: + +*Defined in [types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L153)* + +___ + +### EthSign + +• **EthSign**: + +*Defined in [types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L154)* + +___ + +### Illegal + +• **Illegal**: + +*Defined in [types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L151)* + +___ + +### Invalid + +• **Invalid**: + +*Defined in [types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L152)* + +___ + +### NSignatureTypes + +• **NSignatureTypes**: + +*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L159)* + +___ + +### PreSigned + +• **PreSigned**: + +*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L157)* + +___ + +### Validator + +• **Validator**: + +*Defined in [types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L156)* + +___ + +### Wallet + +• **Wallet**: + +*Defined in [types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L155)* + +
@@ -12415,61 +15927,2457 @@ The amount of the asset tranferable by the owner. NOTE: If the `assetData&# +# Interface: ERC20TokenApprovalEventArgs +## Index + +### Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L42)* + +___ + +### _spender + +• **_spender**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L43)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L44)* + +
+ +# Interface: ERC20TokenTransferEventArgs +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L36)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L38)* + +
+ +# Interface: ERC721TokenApprovalEventArgs +## Index + +### Properties + +* [_approved](#_approved) +* [_owner](#_owner) +* [_tokenId](#_tokenid) + +## Properties + +### _approved + +• **_approved**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L41)* + +___ + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L40)* + +___ + +### _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L42)* + +
+ +# Interface: ERC721TokenApprovalForAllEventArgs +## Index + +### Properties + +* [_approved](#_approved) +* [_operator](#_operator) +* [_owner](#_owner) + +## Properties + +### _approved + +• **_approved**: *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L48)* + +___ + +### _operator + +• **_operator**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L47)* + +___ + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L46)* + +
+ +# Interface: ERC721TokenTransferEventArgs +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_tokenId](#_tokenid) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L52)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L53)* + +___ + +### _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L54)* + +
+ +# Interface: ExchangeAssetProxyRegisteredEventArgs +## Index + +### Properties + +* [assetProxy](#assetproxy) +* [id](#id) + +## Properties + +### assetProxy + +• **assetProxy**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* + +___ + +### id + +• **id**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* + +
+ +# Interface: ExchangeCancelEventArgs +## Index -# Interface: AwaitTransactionSuccessOpts +### Properties -Used with `awaitTransactionSuccessAsync` -* pollingIntervalMs: Determine polling intervals in milliseconds -* timeoutMs: Determines timeout in milliseconds +* [feeRecipientAddress](#feerecipientaddress) +* [makerAddress](#makeraddress) +* [makerAssetData](#makerassetdata) +* [orderHash](#orderhash) +* [senderAddress](#senderaddress) +* [takerAssetData](#takerassetdata) + +## Properties + +### feeRecipientAddress + +• **feeRecipientAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L56)* + +___ + +### makerAddress + +• **makerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L55)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L57)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:60](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L60)* + +___ + +### senderAddress + +• **senderAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L59)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:58](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L58)* + +
+ +# Interface: ExchangeCancelUpToEventArgs + + +## Index + +### Properties + +* [makerAddress](#makeraddress) +* [orderEpoch](#orderepoch) +* [orderSenderAddress](#ordersenderaddress) + +## Properties + +### makerAddress + +• **makerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* + +___ + +### orderEpoch + +• **orderEpoch**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* + +___ + +### orderSenderAddress + +• **orderSenderAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* + +
+ +# Interface: ExchangeFillEventArgs + + +## Index + +### Properties + +* [feeRecipientAddress](#feerecipientaddress) +* [makerAddress](#makeraddress) +* [makerAssetData](#makerassetdata) +* [makerAssetFilledAmount](#makerassetfilledamount) +* [makerFeeAssetData](#makerfeeassetdata) +* [makerFeePaid](#makerfeepaid) +* [orderHash](#orderhash) +* [protocolFeePaid](#protocolfeepaid) +* [senderAddress](#senderaddress) +* [takerAddress](#takeraddress) +* [takerAssetData](#takerassetdata) +* [takerAssetFilledAmount](#takerassetfilledamount) +* [takerFeeAssetData](#takerfeeassetdata) +* [takerFeePaid](#takerfeepaid) + +## Properties + +### feeRecipientAddress + +• **feeRecipientAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:71](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L71)* + +___ + +### makerAddress + +• **makerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L70)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L72)* + +___ + +### makerAssetFilledAmount + +• **makerAssetFilledAmount**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* + +___ + +### makerFeeAssetData + +• **makerFeeAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L74)* + +___ + +### makerFeePaid + +• **makerFeePaid**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:76](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L76)* + +___ + +### protocolFeePaid + +• **protocolFeePaid**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)* + +___ + +### senderAddress + +• **senderAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L78)* + +___ + +### takerAddress + +• **takerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:77](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L77)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L73)* + +___ + +### takerAssetFilledAmount + +• **takerAssetFilledAmount**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* + +___ + +### takerFeeAssetData + +• **takerFeeAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L75)* + +___ + +### takerFeePaid + +• **takerFeePaid**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)* + +
+ +# Interface: ExchangeProtocolFeeCollectorAddressEventArgs + + +## Index + +### Properties + +* [oldProtocolFeeCollector](#oldprotocolfeecollector) +* [updatedProtocolFeeCollector](#updatedprotocolfeecollector) + +## Properties + +### oldProtocolFeeCollector + +• **oldProtocolFeeCollector**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)* + +___ + +### updatedProtocolFeeCollector + +• **updatedProtocolFeeCollector**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)* + +
+ +# Interface: ExchangeProtocolFeeMultiplierEventArgs + + +## Index + +### Properties + +* [oldProtocolFeeMultiplier](#oldprotocolfeemultiplier) +* [updatedProtocolFeeMultiplier](#updatedprotocolfeemultiplier) + +## Properties + +### oldProtocolFeeMultiplier + +• **oldProtocolFeeMultiplier**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L92)* + +___ + +### updatedProtocolFeeMultiplier + +• **updatedProtocolFeeMultiplier**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L93)* + +
+ +# Interface: ExchangeSignatureValidatorApprovalEventArgs + + +## Index + +### Properties + +* [isApproved](#isapproved) +* [signerAddress](#signeraddress) +* [validatorAddress](#validatoraddress) + +## Properties + +### isApproved + +• **isApproved**: *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:99](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L99)* + +___ + +### signerAddress + +• **signerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:97](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L97)* + +___ + +### validatorAddress + +• **validatorAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:98](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L98)* + +
+ +# Interface: ExchangeTransactionExecutionEventArgs + + +## Index + +### Properties + +* [transactionHash](#transactionhash) + +## Properties + +### transactionHash + +• **transactionHash**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L103)* + +
+ +# Interface: WETH9ApprovalEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L42)* + +___ + +### _spender + +• **_spender**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L43)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* + +
+ +# Interface: WETH9DepositEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L54)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L55)* + +
+ +# Interface: WETH9TransferEventArgs + + +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L48)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L49)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L50)* + +
+ +# Interface: WETH9WithdrawalEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L59)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L60)* + +
+ +# Interface: ZRXTokenApprovalEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L42)* + +___ + +### _spender + +• **_spender**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L43)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L44)* + +
+ +# Interface: ZRXTokenTransferEventArgs + + +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L36)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L37)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L38)* + +
+ +# Interface: ContractAddresses ## Properties -### `Optional` pollingIntervalMs +### assetProxyOwner -• **pollingIntervalMs**? : *undefined | number* +• **assetProxyOwner**: *string* -*Overrides [SendTransactionOpts](_types_src_index_.sendtransactionopts.md).[pollingIntervalMs](#optional-pollingintervalms)* - -*Defined in [types/src/index.ts:877](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L877)* +*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L9)* ___ -### `Optional` shouldValidate +### coordinator -• **shouldValidate**? : *undefined | false | true* +• **coordinator**: *string* -*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/44793a9cf/packages/types/src/index.ts#L680)* +*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L14)* ___ -### `Optional` timeoutMs +### coordinatorRegistry -• **timeoutMs**? : *undefined | number* +• **coordinatorRegistry**: *string* -*Overrides [SendTransactionOpts](_types_src_index_.sendtransactionopts.md).[timeoutMs](#optional-timeoutms)* +*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L13)* -*Defined in [types/src/index.ts:878](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L878)* +___ + +### devUtils + +• **devUtils**: *string* + +*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L18)* + +___ + +### dutchAuction + +• **dutchAuction**: *string* + +*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L12)* + +___ + +### erc1155Proxy + +• **erc1155Proxy**: *string* + +*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L17)* + +___ + +### erc20Proxy + +• **erc20Proxy**: *string* + +*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L4)* + +___ + +### erc721Proxy + +• **erc721Proxy**: *string* + +*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L5)* + +___ + +### etherToken + +• **etherToken**: *string* + +*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L7)* + +___ + +### exchange + +• **exchange**: *string* + +*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L8)* + +___ + +### forwarder + +• **forwarder**: *string* + +*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L10)* + +___ + +### multiAssetProxy + +• **multiAssetProxy**: *string* + +*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L15)* + +___ + +### orderValidator + +• **orderValidator**: *string* + +*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L11)* + +___ + +### staticCallProxy + +• **staticCallProxy**: *string* + +*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L16)* + +___ + +### zrxToken + +• **zrxToken**: *string* + +*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L6)*
+ + + +# Interface: BlockRange + + +## Properties + +### fromBlock + +• **fromBlock**: *[BlockParam](#blockparam)* + +*Defined in [ethereum-types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L740)* + +___ + +### toBlock + +• **toBlock**: *[BlockParam](#blockparam)* + +*Defined in [ethereum-types/src/index.ts:741](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L741)* + +
+ + + + + +# Interface: CallData + + +## Properties + +### `Optional` data + +• **data**? : *undefined | string* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* + +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* + +___ + +### `Optional` from + +• **from**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L402)* + +___ + +### `Optional` gas + +• **gas**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* + +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* + +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* + +___ + +### `Optional` nonce + +• **nonce**? : *undefined | number* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* + +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* + +___ + +### `Optional` to + +• **to**? : *undefined | string* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* + +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* + +___ + +### `Optional` value + +• **value**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* + +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)* + +
+ + + + + +# Interface: CompilerOpts + + +## Properties + +### name + +• **name**: *"solc"* + +*Defined in [ethereum-types/src/index.ts:655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L655)* + +___ + +### settings + +• **settings**: *[CompilerSettings](#class-compilersettings)* + +*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L657)* + +___ + +### version + +• **version**: *string* + +*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L656)* + +
+ +# 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/9fe6c196a/packages/ethereum-types/src/index.ts#L689)* + +___ + +### `Optional` libraries + +• **libraries**? : *undefined | object* + +*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L691)* + +___ + +### `Optional` metadata + +• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* + +*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L690)* + +___ + +### `Optional` optimizer + +• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* + +*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L688)* + +___ + +### outputSelection + +• **outputSelection**: *object* + +*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L696)* + +#### 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/9fe6c196a/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/9fe6c196a/packages/ethereum-types/src/index.ts#L704)* + +
+ +# Interface: ConstructorAbi + + +## Properties + +### inputs + +• **inputs**: *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L103)* + +___ + +### payable + +• **payable**: *boolean* + +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L104)* + +___ + +### stateMutability + +• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* + +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L105)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L102)* + +
+ +# Interface: ContractArtifact + +This type defines the schema of the artifact.json file generated by Sol-compiler +schemaVersion: The version of the artifact schema +contractName: The contract name it represents +networks: Network specific information by network (address, id, constructor args, etc...) +compilerOutput: The Solidity compiler output generated from the specified compiler input +description (http://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description) +compiler: The compiler settings used +sourceCodes: The source code of the contract and all it's dependencies +sources: A mapping from source filePath to sourceMap id +sourceTreeHashHex: A unique hash generated from the contract source and that of it's dependencies. +If any of the sources change, the hash would change notifying us that a re-compilation is necessary + + +## Properties + +### compiler + +• **compiler**: *[CompilerOpts](#class-compileropts)* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* + +*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L641)* + +___ + +### compilerOutput + +• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* + +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L651)* + +___ + +### contractName + +• **contractName**: *string* + +*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L675)* + +___ + +### networks + +• **networks**: *[ContractNetworks](#class-contractnetworks)* + +*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L676)* + +___ + +### schemaVersion + +• **schemaVersion**: *string* + +*Defined in [ethereum-types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L674)* + +___ + +### sourceCodes + +• **sourceCodes**: *object* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* + +*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L647)* + +#### Type declaration: + +● \[▪ **sourceName**: *string*\]: string + +___ + +### sourceTreeHashHex + +• **sourceTreeHashHex**: *string* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* + +*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L650)* + +___ + +### sources + +• **sources**: *object* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* + +*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L642)* + +#### Type declaration: + +● \[▪ **sourceName**: *string*\]: object + +
+ +# Interface: ContractNetworkData + + +## Properties + +### address + +• **address**: *string* + +*Defined in [ethereum-types/src/index.ts:554](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L554)* + +___ + +Args + +• **constructorArgs**: *string* + +*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L558)* + +___ + +### links + +• **links**: *object* + +*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L555)* + +#### Type declaration: + +● \[▪ **linkName**: *string*\]: string + +
+ +# Interface: ContractNetworks + + +## Hierarchy + +* **ContractVersionData** + + * [ContractArtifact](#class-contractartifact) + + +## Properties + +### compiler + +• **compiler**: *[CompilerOpts](#class-compileropts)* + +*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L641)* + +___ + +### compilerOutput + +• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* + +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L651)* + +___ + +### sourceCodes + +• **sourceCodes**: *object* + +*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L647)* + +#### Type declaration: + +● \[▪ **sourceName**: *string*\]: string + +___ + +### sourceTreeHashHex + +• **sourceTreeHashHex**: *string* + +*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L650)* + +___ + +### sources + +• **sources**: *object* + +*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L642)* + +#### Type declaration: + +● \[▪ **sourceName**: *string*\]: object + +
+ +# Interface: DataItem + + +## Properties + +### `Optional` components + +• **components**? : *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* + +___ + +### name + +• **name**: *string* + +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)* + +
+ +# Interface: DecodedLogArgs + + +## Type parameters + +▪ **A** + + +## Properties + +### address + +• **address**: *string* + +*Inherited from [LogEntry](#interface-logentry).[address](#address)* + +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* + +___ + +### args + +• **args**: *`A`* + +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* + +___ + +### blockHash + +• **blockHash**: *string | null* + +*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* + +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* + +___ + +### blockNumber + +• **blockNumber**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* + +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* + +___ + +### data + +• **data**: *string* + +*Inherited from [LogEntry](#interface-logentry).[data](#data)* + +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* + +___ + +### event + +• **event**: *string* + +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* + +___ + +### logIndex + +• **logIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* + +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* + +___ + +### topics + +• **topics**: *string[]* + +*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* + +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* + +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* + +___ + +### transactionIndex + +• **transactionIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* + +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)* + +
+ + + +# Interface: DevdocOutput + + +## Properties + +### `Optional` author + +• **author**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L628)* + +___ + +### methods + +• **methods**: *object* + +*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L629)* + +#### Type declaration: + +● \[▪ **signature**: *string*\]: object + +___ + +### `Optional` title + +• **title**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L627)* + +
+ +# Interface: EIP1193Provider + + +## Properties + +### isEIP1193 + +• **isEIP1193**: *boolean* + +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* + +## Methods + +### on + +▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* + +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* + +**Parameters:** + +▪ **event**: *[EIP1193Event](#eip1193event)* + +▪ **listener**: *function* + +▸ (`result`: any): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`result` | any | + +**Returns:** *this* + +___ + +### send + +▸ **send**(`method`: string, `params?`: any[]): *`Promise`* + +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* + +**Parameters:** + +Name | Type | +------ | ------ | +`method` | string | +`params?` | any[] | + +**Returns:** *`Promise`* + +
+ + + + + +# Interface: EvmBytecodeOutput + + +## Properties + +### object + +• **object**: *string* + +*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L622)* + +___ + +### sourceMap + +• **sourceMap**: *string* + +*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L623)* + +
+ +# Interface: EvmOutput + + +## Properties + +### bytecode + +• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* + +*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L617)* + +___ + +### deployedBytecode + +• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* + +*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L618)* + +
+ +# Interface: FallbackAbi + + +## Properties + +### payable + +• **payable**: *boolean* + +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L112)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L111)* + +
+ + + +# Interface: GanacheProvider + + +## Methods + +### sendAsync + +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* + +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L14)* + +**Parameters:** + +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | + +**Returns:** *void* + +
+ + + +# Interface: JSONRPCRequestPayload + + +## Properties + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* + +___ + +### method + +• **method**: *string* + +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* + +___ + +### params + +• **params**: *any[]* + +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)* + +
+ +# Interface: JSONRPCResponseError + + +## Properties + +### code + +• **code**: *number* + +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* + +___ + +### message + +• **message**: *string* + +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)* + +
+ +# Interface: JSONRPCResponsePayload + + +## Properties + +### `Optional` error + +• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* + +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* + +___ + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* + +___ + +### result + +• **result**: *any* + +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)* + +
+ + + + + +# Interface: LogWithDecodedArgs <**ArgsType**> + +## Type parameters + +▪ **ArgsType**: *[DecodedLogArgs](#class-decodedlogargs)* + + +## Properties + +### address + +• **address**: *string* + +*Inherited from [LogEntry](#interface-logentry).[address](#address)* + +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* + +___ + +### args + +• **args**: *`ArgsType`* + +*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* + +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* + +___ + +### blockHash + +• **blockHash**: *string | null* + +*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* + +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* + +___ + +### blockNumber + +• **blockNumber**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* + +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* + +___ + +### data + +• **data**: *string* + +*Inherited from [LogEntry](#interface-logentry).[data](#data)* + +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* + +___ + +### event + +• **event**: *string* + +*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* + +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* + +___ + +### logIndex + +• **logIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* + +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* + +___ + +### topics + +• **topics**: *string[]* + +*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* + +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* + +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* + +___ + +### transactionIndex + +• **transactionIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* + +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)* + +
+ +# Interface: MethodAbi + + +## Properties + +### constant + +• **constant**: *boolean* + +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L94)* + +___ + +### inputs + +• **inputs**: *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L92)* + +___ + +### name + +• **name**: *string* + +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L91)* + +___ + +### outputs + +• **outputs**: *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L93)* + +___ + +### payable + +• **payable**: *boolean* + +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L96)* + +___ + +### stateMutability + +• **stateMutability**: *[StateMutability](#statemutability)* + +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L95)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L90)* + +
+ +# Interface: OptimizerSettings + + +## Properties + +### enabled + +• **enabled**: *boolean* + +*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L708)* + +___ + +### `Optional` runs + +• **runs**? : *undefined | number* + +*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L709)* + +
+ + + + + +# Interface: RevertErrorAbi + + +## Properties + +### `Optional` arguments + +• **arguments**? : *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L122)* + +___ + +### name + +• **name**: *string* + +*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L121)* + +___ + +### type + +• **type**: *"error"* + +*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L120)* + +
+ + + + + + + +# Interface: StandardContractOutput + + +## Properties + +### abi + +• **abi**: *[ContractAbi](#contractabi)* + +*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L564)* + +___ + +### `Optional` devdoc + +• **devdoc**? : *[DevdocOutput](#class-devdocoutput)* + +*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L566)* + +___ + +### evm + +• **evm**: *[EvmOutput](#class-evmoutput)* + +*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L565)* + +
+ + + + + + + + + + + + + + + +# Interface: TupleDataItem + + +## Properties + +### components + +• **components**: *[DataItem](#class-dataitem)[]* + +*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* + +*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L141)* + +___ + +### name + +• **name**: *string* + +*Inherited from [DataItem](#interface-dataitem).[name](#name)* + +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* + +___ + +### type + +• **type**: *string* + +*Inherited from [DataItem](#interface-dataitem).[type](#type)* + +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* + +___ + +### from + +• **from**: *string* + +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* + +___ + +### `Optional` gas + +• **gas**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* + +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* + +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* + +___ + +### `Optional` nonce + +• **nonce**? : *undefined | number* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* + +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* + +___ + +### `Optional` to + +• **to**? : *undefined | string* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* + +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* + +___ + +### `Optional` value + +• **value**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* + +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)* + +
+ +# Interface: TxDataPayable + + +## Properties + +### `Optional` data + +• **data**? : *undefined | string* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* + +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* + +___ + +### from + +• **from**: *string* + +*Inherited from [TxData](#interface-txdata).[from](#from)* + +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* + +___ + +### `Optional` gas + +• **gas**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* + +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* + +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* + +___ + +### `Optional` nonce + +• **nonce**? : *undefined | number* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* + +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* + +___ + +### `Optional` to + +• **to**? : *undefined | string* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* + +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* + +___ + +### `Optional` value + +• **value**? : *`BigNumber`* + +*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/9fe6c196a/packages/ethereum-types/src/index.ts#L442)* + +
+ +# Interface: Web3JsV1Provider + +Web3.js version 1 provider interface +This provider interface was implemented in the pre-1.0Beta releases for Web3.js. +This interface allowed sending synchonous requests, support for which was later dropped. + + +## Methods + +### send + +▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* + +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)* + +**Parameters:** + +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | + +**Returns:** *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* + +___ + +### sendAsync + +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* + +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)* + +**Parameters:** + +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | + +**Returns:** *void* + +
+ +# Interface: Web3JsV2Provider + +Web3.js version 2 provider interface +This provider interface was used in a couple of Web3.js 1.0 beta releases +before the first attempts to conform to EIP1193 + + +## Methods + +### send + +▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* + +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* + +**Returns:** *`Promise`* + +___ + +### sendAsync + +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* + +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)* + +**Parameters:** + +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | + +**Returns:** *void* + +___ + +### `Optional` stop + +▸ **stop**(): *void* + +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* + +**Returns:** *void* + +
+ + + + + + + +# Interface: JSONRPCRequestPayloadWithMethod + + +## Properties + +### id + +• **id**: *number* + + + +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/9fe6c196a/packages/subproviders/src/types.ts#L136)* + +___ + +### params + +• **params**: *any[]* + + + +Defined in ethereum-types/lib/index.d.ts:265 + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -12494,7 +18402,7 @@ ___ • **isRemoved**: *boolean* -*Defined in [types/src/index.ts:844](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L844)* +*Defined in [types/src/index.ts:853](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L853)* ___ @@ -12502,7 +18410,7 @@ ___ • **log**: *`LogWithDecodedArgs`* -*Defined in [types/src/index.ts:845](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L845)* +*Defined in [types/src/index.ts:854](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L854)*
@@ -12517,7 +18425,7 @@ ___ • **assetData**: *[AssetData](#assetdata)* -*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L219)* +*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L219)* ___ @@ -12525,7 +18433,7 @@ ___ • **beginAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L221)* +*Defined in [types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L221)* ___ @@ -12533,7 +18441,7 @@ ___ • **beginTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L220)* +*Defined in [types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L220)*
@@ -12550,7 +18458,7 @@ Elliptic Curve signature • **r**: *string* -*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L62)* +*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L62)* ___ @@ -12558,7 +18466,7 @@ ___ • **s**: *string* -*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L63)* +*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L63)* ___ @@ -12566,7 +18474,7 @@ ___ • **v**: *number* -*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L61)* +*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L61)*
@@ -12579,7 +18487,7 @@ ___ • **chainId**: *number* -*Defined in [types/src/index.ts:793](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L793)* +*Defined in [types/src/index.ts:802](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L802)* ___ @@ -12587,7 +18495,7 @@ ___ • **name**? : *undefined | string* -*Defined in [types/src/index.ts:791](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L791)* +*Defined in [types/src/index.ts:800](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L800)* ___ @@ -12595,7 +18503,7 @@ ___ • **verifyingContract**: *string* -*Defined in [types/src/index.ts:794](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L794)* +*Defined in [types/src/index.ts:803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L803)* ___ @@ -12603,7 +18511,7 @@ ___ • **version**? : *undefined | string* -*Defined in [types/src/index.ts:792](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L792)* +*Defined in [types/src/index.ts:801](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L801)*
@@ -12622,7 +18530,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L183)* +*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L183)* ___ @@ -12630,7 +18538,7 @@ ___ • **callbackData**: *string* -*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L187)* +*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L187)* ___ @@ -12638,7 +18546,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L184)* +*Defined in [types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L184)* ___ @@ -12646,7 +18554,7 @@ ___ • **tokenIds**: *`BigNumber`[]* -*Defined in [types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L185)* +*Defined in [types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L185)* ___ @@ -12654,7 +18562,7 @@ ___ • **tokenValues**: *`BigNumber`[]* -*Defined in [types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L186)* +*Defined in [types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L186)*
@@ -12669,7 +18577,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L172)* +*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L172)* ___ @@ -12677,7 +18585,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L173)* +*Defined in [types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L173)*
@@ -12690,7 +18598,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L177)* +*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L177)* ___ @@ -12698,7 +18606,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L178)* +*Defined in [types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L178)* ___ @@ -12706,7 +18614,7 @@ ___ • **tokenId**: *`BigNumber`* -*Defined in [types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L179)* +*Defined in [types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L179)*
@@ -12734,7 +18642,7 @@ ___ • **keyName**: *string* -*Defined in [types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L691)* +*Defined in [types/src/index.ts:679](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L679)* ___ @@ -12742,7 +18650,7 @@ ___ • **keyType**: *[Type](#class-type)* -*Defined in [types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L692)* +*Defined in [types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L680)* ___ @@ -12750,7 +18658,7 @@ ___ • **valueName**: *string* -*Defined in [types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L693)* +*Defined in [types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L681)*
@@ -12767,7 +18675,7 @@ ___ • **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L208)* +*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L208)* ___ @@ -12775,7 +18683,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L207)* +*Defined in [types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L207)* ___ @@ -12783,7 +18691,7 @@ ___ • **nestedAssetData**: *string[]* -*Defined in [types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L209)* +*Defined in [types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L209)*
@@ -12796,7 +18704,7 @@ ___ • **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L214)* +*Defined in [types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L214)* ___ @@ -12804,7 +18712,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L213)* +*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L213)* ___ @@ -12812,7 +18720,7 @@ ___ • **nestedAssetData**: *[SingleAssetData](#singleassetdata)[]* -*Defined in [types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L215)* +*Defined in [types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L215)*
@@ -12851,45 +18759,6 @@ ___ - -# 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/44793a9cf/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/44793a9cf/packages/types/src/index.ts#L680)* - -*Defined in [types/src/index.ts:868](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/packages/types/src/index.ts#L682)* - -
# Interface: SignedOrder @@ -12902,7 +18771,7 @@ ___ *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* ___ @@ -12912,7 +18781,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -12922,7 +18791,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -12932,7 +18801,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -12942,7 +18811,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -12952,7 +18821,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -12962,7 +18831,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -12972,7 +18841,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* ___ @@ -12982,7 +18851,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -12992,7 +18861,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -13002,7 +18871,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -13010,7 +18879,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -13020,7 +18889,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -13030,7 +18899,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -13040,7 +18909,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -13050,7 +18919,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* ___ @@ -13060,7 +18929,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -13075,7 +18944,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* ___ @@ -13085,7 +18954,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[domain](#domain)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* ___ @@ -13095,7 +18964,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* ___ @@ -13105,7 +18974,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[gasPrice](#gasprice)* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* ___ @@ -13115,7 +18984,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* ___ @@ -13123,7 +18992,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L54)* +*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L54)* ___ @@ -13133,7 +19002,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L48)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)*
@@ -13146,7 +19015,7 @@ ___ • **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)* -*Defined in [types/src/index.ts:884](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L884)* +*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L748)* ___ @@ -13154,7 +19023,7 @@ ___ • **contractName**: *string* -*Defined in [types/src/index.ts:883](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L883)* +*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L747)* ___ @@ -13162,7 +19031,7 @@ ___ • **networks**: *`ContractNetworks`* -*Defined in [types/src/index.ts:885](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L885)* +*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L749)* ___ @@ -13170,7 +19039,7 @@ ___ • **schemaVersion**: *string* -*Defined in [types/src/index.ts:882](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L882)* +*Defined in [types/src/index.ts:746](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L746)*
@@ -13183,7 +19052,7 @@ ___ • **object**: *string* -*Defined in [types/src/index.ts:899](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L899)* +*Defined in [types/src/index.ts:763](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L763)*
@@ -13196,7 +19065,7 @@ ___ • **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)* -*Defined in [types/src/index.ts:895](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L895)* +*Defined in [types/src/index.ts:759](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L759)*
@@ -13209,7 +19078,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [types/src/index.ts:889](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L889)* +*Defined in [types/src/index.ts:753](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L753)* ___ @@ -13217,7 +19086,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [types/src/index.ts:891](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L891)* +*Defined in [types/src/index.ts:755](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L755)* ___ @@ -13225,7 +19094,7 @@ ___ • **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)* -*Defined in [types/src/index.ts:890](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L890)* +*Defined in [types/src/index.ts:754](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L754)*
@@ -13242,7 +19111,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L191)* +*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L191)* ___ @@ -13250,7 +19119,7 @@ ___ • **callResultHash**: *string* -*Defined in [types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L194)* +*Defined in [types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L194)* ___ @@ -13258,7 +19127,7 @@ ___ • **callTarget**: *string* -*Defined in [types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L192)* +*Defined in [types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L192)* ___ @@ -13266,7 +19135,7 @@ ___ • **staticCallData**: *string* -*Defined in [types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L193)* +*Defined in [types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L193)*
@@ -13307,7 +19176,7 @@ Validator signature components • **signature**: *string* -*Defined in [types/src/index.ts:71](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L71)* +*Defined in [types/src/index.ts:71](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L71)* ___ @@ -13315,7 +19184,7 @@ ___ • **validatorAddress**: *string* -*Defined in [types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L70)* +*Defined in [types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L70)*
@@ -13330,7 +19199,7 @@ ZeroExTransaction for use with 0x Exchange executeTransaction • **data**: *string* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* ___ @@ -13338,7 +19207,7 @@ ___ • **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* ___ @@ -13346,7 +19215,7 @@ ___ • **expirationTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* ___ @@ -13354,7 +19223,7 @@ ___ • **gasPrice**: *`BigNumber`* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* ___ @@ -13362,7 +19231,7 @@ ___ • **salt**: *`BigNumber`* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* ___ @@ -13370,63 +19239,7 @@ ___ • **signerAddress**: *string* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/packages/types/src/index.ts#L224)* - -___ - - - - - - - -### EventCallback - -Ƭ **EventCallback**: *function* - -*Defined in [types/src/index.ts:848](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/packages/types/src/index.ts#L204)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)*
@@ -13443,7 +19256,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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L28)*
@@ -13456,7 +19269,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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L28)*
@@ -13469,7 +19282,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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L28)*
@@ -13490,7 +19303,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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L28)*
@@ -13503,7 +19316,7 @@ ___ Ƭ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L28)*
@@ -13516,7 +19329,7 @@ ___ ▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)* -*Defined in [contract-addresses/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L164)* +*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L128)* Used to get addresses of contracts that have been deployed to either the Ethereum mainnet or a supported testnet. Throws if there are no known @@ -13544,7 +19357,7 @@ given networkId. Ƭ **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/44793a9cf/packages/ethereum-types/src/index.ts#L80)* +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L80)* ___ @@ -13552,7 +19365,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L483)* +*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L483)* ___ @@ -13560,7 +19373,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L84)* ___ @@ -13568,7 +19381,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L78)* +*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L78)* ___ @@ -13576,7 +19389,7 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L468)* +*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L468)* ___ @@ -13586,7 +19399,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -13601,7 +19414,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/44793a9cf/packages/ethereum-types/src/index.ts#L82)* +*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L82)* ___ @@ -13609,7 +19422,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -13630,7 +19443,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/44793a9cf/packages/ethereum-types/src/index.ts#L525)* +*Defined in [ethereum-types/src/index.ts:525](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L525)* ___ @@ -13638,7 +19451,7 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L561)* +*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L561)* ___ @@ -13648,7 +19461,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L85)* ___ @@ -13656,7 +19469,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/44793a9cf/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -13671,7 +19484,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/44793a9cf/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)*
@@ -13684,13 +19497,13 @@ ___ #### ▪ **assetDataUtils**: *object* -*Defined in [order-utils/src/asset_data_utils.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L397)* Throws if the assetData is not ERC1155. @@ -13706,7 +19519,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L353)* Throws if the length or assetProxyId are invalid for the ERC20Proxy. @@ -13722,7 +19535,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L375)* Throws if the length or assetProxyId are invalid for the ERC721Proxy. @@ -13738,7 +19551,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L419)* Throws if the length or assetProxyId are invalid for the MultiAssetProxy. @@ -13754,7 +19567,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L441)* Throws if the assetData is not StaticCallData. @@ -13770,7 +19583,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L463)* Throws if the assetData is not padded to 32 bytes. @@ -13786,7 +19599,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L502)* Decode any assetData into its corresponding assetData object @@ -13804,7 +19617,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L294)* Decode and return the assetProxyId from the assetData @@ -13822,7 +19635,7 @@ The assetProxyId ▸ **decodeDutchAuctionData**(`dutchAuctionData`: string): *`DutchAuctionData`* -*Defined in [order-utils/src/asset_data_utils.ts:263](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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 @@ -13842,7 +19655,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L107)* Decodes an ERC1155 assetData hex string into its corresponding ERC1155 components. @@ -13860,7 +19673,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L41)* Decodes an ERC20 assetData hex string into its corresponding ERC20 tokenAddress & assetProxyId @@ -13878,7 +19691,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L70)* Decodes an ERC721 assetData hex string into its corresponding ERC721 tokenAddress, tokenId & assetProxyId @@ -13896,7 +19709,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L149)* Decodes a MultiAsset assetData hex string into its corresponding amounts and nestedAssetData @@ -13914,7 +19727,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/44793a9cf/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/9fe6c196a/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) @@ -13932,7 +19745,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L225)* Decoded StaticCall assetData into its corresponding callTarget, staticCallData, and expected callResultHash @@ -13950,7 +19763,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/44793a9cf/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/9fe6c196a/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 @@ -13972,7 +19785,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/44793a9cf/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/9fe6c196a/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. @@ -13994,7 +19807,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/44793a9cf/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/9fe6c196a/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. @@ -14013,7 +19826,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/44793a9cf/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/9fe6c196a/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. @@ -14033,7 +19846,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/44793a9cf/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/9fe6c196a/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. @@ -14053,7 +19866,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L214)* Encodes StaticCallProxy data into an assetData hex string @@ -14073,7 +19886,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L332)* Checks if the decoded asset data is valid ERC1155 data @@ -14089,7 +19902,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L318)* Checks if the decoded asset data is valid ERC20 data @@ -14105,7 +19918,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L325)* Checks if the decoded asset data is valid ERC721 data @@ -14121,7 +19934,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L339)* Checks if the decoded asset data is valid MultiAsset data @@ -14137,7 +19950,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L346)* Checks if the decoded asset data is valid StaticCall data @@ -14153,7 +19966,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L475)* Throws if the length or assetProxyId are invalid for the corresponding AssetProxy. @@ -14176,13 +19989,13 @@ Name | Type | Description | #### ▪ **orderHashUtils**: *object* -*Defined in [order-utils/src/order_hash.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_hash.ts#L12)* +*Defined in [order-utils/src/order_hash.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/order-utils/src/order_hash.ts#L55)* +*Defined in [order-utils/src/order_hash.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_hash.ts#L55)* Computes the orderHash for a supplied order @@ -14200,7 +20013,7 @@ A Buffer containing the resulting orderHash from hashing the supplied order ▸ **getOrderHashHex**(`order`: `SignedOrder` | `Order`): *string* -*Defined in [order-utils/src/order_hash.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_hash.ts#L33)* +*Defined in [order-utils/src/order_hash.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_hash.ts#L33)* Computes the orderHash for a supplied order. @@ -14218,7 +20031,7 @@ Hex encoded string orderHash from hashing the supplied order. ▸ **isValidOrderHash**(`orderHash`: string): *boolean* -*Defined in [order-utils/src/order_hash.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_hash.ts#L20)* +*Defined in [order-utils/src/order_hash.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -14245,7 +20058,7 @@ Whether the supplied orderHash has the expected format. ▸ **generatePseudoRandomSalt**(): *`BigNumber`* -*Defined in [order-utils/src/salt.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/salt.ts#L9)* +*Defined in [order-utils/src/salt.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -14266,13 +20079,13 @@ A pseudo-random 256-bit number that can be used as a salt. #### ▪ **signatureUtils**: *object* -*Defined in [order-utils/src/signature_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L27)* +*Defined in [order-utils/src/signature_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L27)* #### addSignedMessagePrefix ▸ **addSignedMessagePrefix**(`message`: string): *string* -*Defined in [order-utils/src/signature_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L500)* +*Defined in [order-utils/src/signature_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L500)* Adds the relevant prefix to the message being signed. @@ -14290,7 +20103,7 @@ Prefixed message ▸ **convertECSignatureToSignatureHex**(`ecSignature`: `ECSignature`): *string* -*Defined in [order-utils/src/signature_utils.ts:474](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L474)* +*Defined in [order-utils/src/signature_utils.ts:474](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L474)* Combines ECSignature with V,R,S and the EthSign signature type for use in 0x protocol @@ -14308,7 +20121,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L490)* +*Defined in [order-utils/src/signature_utils.ts:490](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L490)* Combines the signature proof and the Signature Type. @@ -14327,7 +20140,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L417)* +*Defined in [order-utils/src/signature_utils.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L417)* Signs a hash using `eth_sign` and returns its elliptic curve signature and signature type. @@ -14347,7 +20160,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L252)* +*Defined in [order-utils/src/signature_utils.ts:252](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L252)* Signs an order and returns a SignedOrder. First `eth_signTypedData` is requested then a fallback to `eth_sign` if not available on the supplied provider. @@ -14368,7 +20181,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L331)* +*Defined in [order-utils/src/signature_utils.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L331)* Signs a transaction and returns a SignedZeroExTransaction. First `eth_signTypedData` is requested then a fallback to `eth_sign` if not available on the supplied provider. @@ -14389,7 +20202,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L287)* +*Defined in [order-utils/src/signature_utils.ts:287](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L287)* Signs an order using `eth_signTypedData` and returns a SignedOrder. @@ -14409,7 +20222,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L374)* +*Defined in [order-utils/src/signature_utils.ts:374](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L374)* Signs a ZeroExTransaction using `eth_signTypedData` and returns a SignedZeroExTransaction. @@ -14429,7 +20242,7 @@ A SignedZeroExTransaction containing the ZeroExTransaction and Elliptic curve si ▸ **isValidECSignature**(`data`: string, `signature`: `ECSignature`, `signerAddress`: string): *boolean* -*Defined in [order-utils/src/signature_utils.ts:222](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L222)* +*Defined in [order-utils/src/signature_utils.ts:222](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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` @@ -14450,7 +20263,7 @@ Whether the ECSignature is valid. ▸ **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/44793a9cf/packages/order-utils/src/signature_utils.ts#L107)* +*Defined in [order-utils/src/signature_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L107)* Verifies that the provided presigned signature is valid according to the 0x Protocol smart contracts @@ -14471,7 +20284,7 @@ Whether the data was preSigned by the supplied signerAddress ▸ **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/44793a9cf/packages/order-utils/src/signature_utils.ts#L38)* +*Defined in [order-utils/src/signature_utils.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L38)* Verifies that the provided signature is valid according to the 0x Protocol smart contracts @@ -14493,7 +20306,7 @@ Whether the signature is valid for the supplied signerAddress and data. ▸ **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/44793a9cf/packages/order-utils/src/signature_utils.ts#L168)* +*Defined in [order-utils/src/signature_utils.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L168)* Verifies that the provided validator signature is valid according to the 0x Protocol smart contracts @@ -14515,7 +20328,7 @@ Whether the data was preSigned by the supplied signerAddress. ▸ **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/44793a9cf/packages/order-utils/src/signature_utils.ts#L139)* +*Defined in [order-utils/src/signature_utils.ts:139](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L139)* Verifies that the provided wallet signature is valid according to the 0x Protocol smart contracts @@ -14536,7 +20349,7 @@ Whether the data was preSigned by the supplied signerAddress. ▸ **parseECSignature**(`signature`: string): *`ECSignature`* -*Defined in [order-utils/src/signature_utils.ts:512](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L512)* +*Defined in [order-utils/src/signature_utils.ts:512](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L512)* Parse a 0x protocol hex-encoded signature string into its ECSignature components @@ -14554,7 +20367,7 @@ An ECSignature object with r,s,v parameters ▸ **parseValidatorSignature**(`signature`: string): *`ValidatorSignature`* -*Defined in [order-utils/src/signature_utils.ts:529](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L529)* +*Defined in [order-utils/src/signature_utils.ts:529](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L529)* Parse a hex-encoded Validator signature into validator address and signature components @@ -14579,13 +20392,13 @@ A ValidatorSignature with validatorAddress and signature parameters #### ▪ **transactionHashUtils**: *object* -*Defined in [order-utils/src/transaction_hash.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/transaction_hash.ts#L9)* +*Defined in [order-utils/src/transaction_hash.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/order-utils/src/transaction_hash.ts#L41)* +*Defined in [order-utils/src/transaction_hash.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/transaction_hash.ts#L41)* Computes the transactionHash for a supplied 0x transaction. @@ -14603,7 +20416,7 @@ A Buffer containing the resulting transactionHash from hashing the supplied 0x t ▸ **getTransactionHashHex**(`transaction`: `ZeroExTransaction` | `SignedZeroExTransaction`): *string* -*Defined in [order-utils/src/transaction_hash.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/transaction_hash.ts#L30)* +*Defined in [order-utils/src/transaction_hash.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/transaction_hash.ts#L30)* Computes the transactionHash for a supplied 0x transaction. @@ -14621,7 +20434,7 @@ Hex encoded string transactionHash from hashing the supplied order. ▸ **isValidTransactionHash**(`transactionHash`: string): *boolean* -*Defined in [order-utils/src/transaction_hash.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/transaction_hash.ts#L17)* +*Defined in [order-utils/src/transaction_hash.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -14656,7 +20469,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/44793a9cf/packages/subproviders/src/types.ts#L131)* +*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L131)* ##### Type declaration: @@ -14670,7 +20483,7 @@ ___ Ƭ **ErrorCallback**: *function* -*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L130)* +*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L130)* #### Type declaration: @@ -14691,3 +20504,63 @@ ___ + + + +## 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/9fe6c196a/packages/types/src/index.ts#L224)* + +___ + + + + + + + +### EventCallback + +Ƭ **EventCallback**: *function* + +*Defined in [types/src/index.ts:857](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L857)* + +#### 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/9fe6c196a/packages/types/src/index.ts#L204)* + +
+ + + +
+ diff --git a/packages/abi-gen-wrappers/CHANGELOG.json b/packages/abi-gen-wrappers/CHANGELOG.json index b5ee7dd9b7..e58a45f47a 100644 --- a/packages/abi-gen-wrappers/CHANGELOG.json +++ b/packages/abi-gen-wrappers/CHANGELOG.json @@ -18,8 +18,7 @@ "note": "Remove `validateAndSendTransactionAsync`. Replaced with `shouldValidate` key in TxOpts. Defaults to true", "pr": 2243 } - ], - "timestamp": 1573001598 + ] }, { "version": "5.4.0-beta.0", diff --git a/packages/abi-gen-wrappers/CHANGELOG.md b/packages/abi-gen-wrappers/CHANGELOG.md index 7ce55160c2..fc27af744c 100644 --- a/packages/abi-gen-wrappers/CHANGELOG.md +++ b/packages/abi-gen-wrappers/CHANGELOG.md @@ -5,13 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v5.4.0-beta.1 - _November 6, 2019_ - - * Remove debug functions `getABIDecodedTransactionData` and `getABIDecodedReturnData` (#2243) - * Remove `getABIEncodedTransactionData` for constant functions (pure and view) (#2243) - * Introduce TxOpts object for `sendTransactionAsync` and `awaitTransactionSuccessAsync`. Replaces `timeoutMs` and `pollingIntervalMs` arguments for `awaitTransactionSuccessAsync` (#2243) - * Remove `validateAndSendTransactionAsync`. Replaced with `shouldValidate` key in TxOpts. Defaults to true (#2243) - ## v5.4.0-beta.0 - _October 3, 2019_ * Use V3 contracts (#2181) diff --git a/packages/abi-gen/CHANGELOG.json b/packages/abi-gen/CHANGELOG.json index 92a9180943..73b8d81211 100644 --- a/packages/abi-gen/CHANGELOG.json +++ b/packages/abi-gen/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "4.4.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "4.4.0-beta.0", "changes": [ diff --git a/packages/abi-gen/CHANGELOG.md b/packages/abi-gen/CHANGELOG.md index 14e2c6e4d0..d39e9f04dd 100644 --- a/packages/abi-gen/CHANGELOG.md +++ b/packages/abi-gen/CHANGELOG.md @@ -5,14 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v4.4.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - -## v4.4.0-beta.0 - _Invalid date_ - - * Add `getSelector` method to all functions (#2224) - ## v4.3.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/assert/CHANGELOG.json b/packages/assert/CHANGELOG.json index 864824f83d..6989684858 100644 --- a/packages/assert/CHANGELOG.json +++ b/packages/assert/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.2.0-beta.0", "changes": [ diff --git a/packages/assert/CHANGELOG.md b/packages/assert/CHANGELOG.md index 76934afb76..00a806a0fd 100644 --- a/packages/assert/CHANGELOG.md +++ b/packages/assert/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.2.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/asset-buyer/CHANGELOG.json b/packages/asset-buyer/CHANGELOG.json index a6032352d4..9d121469fe 100644 --- a/packages/asset-buyer/CHANGELOG.json +++ b/packages/asset-buyer/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "6.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "6.2.0-beta.0", "changes": [ diff --git a/packages/asset-buyer/CHANGELOG.md b/packages/asset-buyer/CHANGELOG.md index 5edd5e21d4..1e4dbe84fb 100644 --- a/packages/asset-buyer/CHANGELOG.md +++ b/packages/asset-buyer/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v6.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v6.2.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/asset-buyer/docs/reference.mdx b/packages/asset-buyer/docs/reference.mdx index 3f7cacd59f..bab6f5c6a6 100644 --- a/packages/asset-buyer/docs/reference.mdx +++ b/packages/asset-buyer/docs/reference.mdx @@ -1,5 +1,236 @@ +# Class: AssetBuyer +## Constructors + + + +\+ **new AssetBuyer**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orderProvider`: [OrderProvider](#interface-orderprovider), `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* + +*Defined in [asset-buyer/src/asset_buyer.ts:83](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L83)* + +Instantiates a new AssetBuyer instance + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | +`orderProvider` | [OrderProvider](#interface-orderprovider) | - | An object that conforms to OrderProvider, see type for definition. | +`options` | `Partial` | {} | Initialization options for the AssetBuyer. See type definition for details. | + +**Returns:** *[AssetBuyer](#class-assetbuyer)* + +An instance of AssetBuyer + +## Properties + +### expiryBufferSeconds + +• **expiryBufferSeconds**: *number* + +*Defined in [asset-buyer/src/asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L40)* + +___ + +### networkId + +• **networkId**: *number* + +*Defined in [asset-buyer/src/asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L38)* + +___ + +### orderProvider + +• **orderProvider**: *[OrderProvider](#interface-orderprovider)* + +*Defined in [asset-buyer/src/asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L37)* + +___ + +### orderRefreshIntervalMs + +• **orderRefreshIntervalMs**: *number* + +*Defined in [asset-buyer/src/asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L39)* + +___ + +### provider + +• **provider**: *`ZeroExProvider`* + +*Defined in [asset-buyer/src/asset_buyer.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L36)* + +## Methods + +### executeBuyQuoteAsync + +▸ **executeBuyQuoteAsync**(`buyQuote`: [BuyQuote](#interface-buyquote), `options`: `Partial`): *`Promise`* + +*Defined in [asset-buyer/src/asset_buyer.ts:226](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L226)* + +Given a BuyQuote and desired rate, attempt to execute the buy. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`buyQuote` | [BuyQuote](#interface-buyquote) | - | An object that conforms to BuyQuote. See type definition for more information. | +`options` | `Partial` | {} | Options for the execution of the BuyQuote. See type definition for more information. | + +**Returns:** *`Promise`* + +A promise of the txHash. + +___ + +### getAvailableAssetDatasAsync + +▸ **getAvailableAssetDatasAsync**(): *`Promise`* + +*Defined in [asset-buyer/src/asset_buyer.ts:300](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L300)* + +Get the asset data of all assets that are purchaseable with ether token (wETH) in the order provider passed in at init. + +**Returns:** *`Promise`* + +An array of asset data strings that can be purchased using wETH. + +___ + +### getBuyQuoteAsync + +▸ **getBuyQuoteAsync**(`assetData`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* + +*Defined in [asset-buyer/src/asset_buyer.ts:125](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L125)* + +Get a `BuyQuote` containing all information relevant to fulfilling a buy given a desired assetData. +You can then pass the `BuyQuote` to `executeBuyQuoteAsync` to execute the buy. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`assetData` | string | - | The assetData of the desired asset to buy (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | +`assetBuyAmount` | `BigNumber` | - | The amount of asset to buy. | +`options` | `Partial` | {} | Options for the request. See type definition for more information. | + +**Returns:** *`Promise`* + +An object that conforms to BuyQuote that satisfies the request. See type definition for more information. + +___ + +### getBuyQuoteForERC20TokenAddressAsync + +▸ **getBuyQuoteForERC20TokenAddressAsync**(`tokenAddress`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* + +*Defined in [asset-buyer/src/asset_buyer.ts:173](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L173)* + +Get a `BuyQuote` containing all information relevant to fulfilling a buy given a desired ERC20 token address. +You can then pass the `BuyQuote` to `executeBuyQuoteAsync` to execute the buy. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`tokenAddress` | string | - | The ERC20 token address. | +`assetBuyAmount` | `BigNumber` | - | The amount of asset to buy. | +`options` | `Partial` | {} | Options for the request. See type definition for more information. | + +**Returns:** *`Promise`* + +An object that conforms to BuyQuote that satisfies the request. See type definition for more information. + +___ + +### getLiquidityForAssetDataAsync + +▸ **getLiquidityForAssetDataAsync**(`assetData`: string, `options`: `Partial`): *`Promise`* + +*Defined in [asset-buyer/src/asset_buyer.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L192)* + +Returns information about available liquidity for an asset +Does not factor in slippage or fees + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`assetData` | string | - | The assetData of the desired asset to buy (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | +`options` | `Partial` | {} | Options for the request. See type definition for more information. | + +**Returns:** *`Promise`* + +An object that conforms to LiquidityForAssetData that satisfies the request. See type definition for more information. + +___ + +### getOrdersAndFillableAmountsAsync + +▸ **getOrdersAndFillableAmountsAsync**(`assetData`: string, `shouldForceOrderRefresh`: boolean): *`Promise`* + +*Defined in [asset-buyer/src/asset_buyer.ts:309](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L309)* + +Grab orders from the map, if there is a miss or it is time to refresh, fetch and process the orders + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | The assetData of the desired asset to buy (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | +`shouldForceOrderRefresh` | boolean | If set to true, new orders and state will be fetched instead of waiting for the next orderRefreshIntervalMs. | + +**Returns:** *`Promise`* + +___ + +### `Static` getAssetBuyerForProvidedOrders + +▸ **getAssetBuyerForProvidedOrders**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orders`: `SignedOrder`[], `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* + +*Defined in [asset-buyer/src/asset_buyer.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L53)* + +Instantiates a new AssetBuyer instance given existing liquidity in the form of orders and feeOrders. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | +`orders` | `SignedOrder`[] | - | A non-empty array of objects that conform to SignedOrder. All orders must have the same makerAssetData and takerAssetData (WETH). | +`options` | `Partial` | {} | Initialization options for the AssetBuyer. See type definition for details. | + +**Returns:** *[AssetBuyer](#class-assetbuyer)* + +An instance of AssetBuyer + +___ + +### `Static` getAssetBuyerForStandardRelayerAPIUrl + +▸ **getAssetBuyerForStandardRelayerAPIUrl**(`supportedProvider`: [SupportedProvider](#supportedprovider), `sraApiUrl`: string, `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* + +*Defined in [asset-buyer/src/asset_buyer.ts:72](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/asset_buyer.ts#L72)* + +Instantiates a new AssetBuyer instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | +`sraApiUrl` | string | - | The standard relayer API base HTTP url you would like to source orders from. | +`options` | `Partial` | {} | Initialization options for the AssetBuyer. See type definition for details. | + +**Returns:** *[AssetBuyer](#class-assetbuyer)* + +An instance of AssetBuyer + +
+ # Class: InsufficientAssetLiquidityError Error class representing insufficient asset liquidity @@ -11,7 +242,7 @@ Error class representing insufficient asset liquidity \+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* -*Defined in [asset-buyer/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/errors.ts#L12)* +*Defined in [asset-buyer/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/errors.ts#L12)* **Parameters:** @@ -27,7 +258,7 @@ Name | Type | Description | • **amountAvailableToFill**: *`BigNumber`* -*Defined in [asset-buyer/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/errors.ts#L12)* +*Defined in [asset-buyer/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/errors.ts#L12)* The amount availabe to fill (in base units) factoring in slippage. @@ -87,7 +318,7 @@ ___ \+ **new BasicOrderProvider**(`orders`: `SignedOrder`[]): *[BasicOrderProvider](#class-basicorderprovider)* -*Defined in [asset-buyer/src/order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* +*Defined in [asset-buyer/src/order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* Instantiates a new BasicOrderProvider instance @@ -107,7 +338,7 @@ An instance of BasicOrderProvider • **orders**: *`SignedOrder`[]* -*Defined in [asset-buyer/src/order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* +*Defined in [asset-buyer/src/order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* ## Methods @@ -115,7 +346,7 @@ An instance of BasicOrderProvider ▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* -*Defined in [asset-buyer/src/order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L37)* +*Defined in [asset-buyer/src/order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L37)* Given a taker asset data string, return all availabled paired maker asset data strings. @@ -135,7 +366,7 @@ ___ ▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* -*Defined in [asset-buyer/src/order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L24)* +*Defined in [asset-buyer/src/order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L24)* Given an object that conforms to OrderFetcherRequest, return the corresponding OrderProviderResponse that satisfies the request. @@ -165,7 +396,7 @@ An instance of OrderProviderResponse. See type for more information. \+ **new StandardRelayerAPIOrderProvider**(`apiUrl`: string, `networkId`: number): *[StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider)* -*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L48)* +*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L48)* Instantiates a new StandardRelayerAPIOrderProvider instance @@ -186,7 +417,7 @@ An instance of StandardRelayerAPIOrderProvider • **apiUrl**: *string* -*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L17)* +*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L17)* ___ @@ -194,7 +425,7 @@ ___ • **networkId**: *number* -*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L18)* +*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L18)* ## Methods @@ -202,7 +433,7 @@ ___ ▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* -*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L91)* +*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L91)* Given a taker asset data string, return all availabled paired maker asset data strings. @@ -222,7 +453,7 @@ ___ ▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* -*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:67](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L67)* +*Defined in [asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts:67](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L67)* Given an object that conforms to OrderProviderRequest, return the corresponding OrderProviderResponse that satisfies the request. @@ -249,7 +480,7 @@ Possible error messages thrown by an AssetBuyer instance or associated static me • **AssetUnavailable**: = "ASSET_UNAVAILABLE" -*Defined in [asset-buyer/src/types.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L122)* +*Defined in [asset-buyer/src/types.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L122)* ___ @@ -257,7 +488,7 @@ ___ • **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" -*Defined in [asset-buyer/src/types.ts:118](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L118)* +*Defined in [asset-buyer/src/types.ts:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L118)* ___ @@ -265,7 +496,7 @@ ___ • **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY" -*Defined in [asset-buyer/src/types.ts:119](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L119)* +*Defined in [asset-buyer/src/types.ts:119](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L119)* ___ @@ -273,7 +504,7 @@ ___ • **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE" -*Defined in [asset-buyer/src/types.ts:121](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L121)* +*Defined in [asset-buyer/src/types.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L121)* ___ @@ -281,7 +512,7 @@ ___ • **NoAddressAvailable**: = "NO_ADDRESS_AVAILABLE" -*Defined in [asset-buyer/src/types.ts:120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L120)* +*Defined in [asset-buyer/src/types.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L120)* ___ @@ -289,7 +520,7 @@ ___ • **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND" -*Defined in [asset-buyer/src/types.ts:115](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L115)* +*Defined in [asset-buyer/src/types.ts:115](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L115)* ___ @@ -297,7 +528,7 @@ ___ • **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND" -*Defined in [asset-buyer/src/types.ts:116](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L116)* +*Defined in [asset-buyer/src/types.ts:116](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L116)* ___ @@ -305,7 +536,7 @@ ___ • **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" -*Defined in [asset-buyer/src/types.ts:123](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L123)* +*Defined in [asset-buyer/src/types.ts:123](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L123)* ___ @@ -313,7 +544,7 @@ ___ • **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR" -*Defined in [asset-buyer/src/types.ts:117](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L117)* +*Defined in [asset-buyer/src/types.ts:117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L117)* ___ @@ -321,7 +552,7 @@ ___ • **TransactionValueTooLow**: = "TRANSACTION_VALUE_TOO_LOW" -*Defined in [asset-buyer/src/types.ts:124](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L124)* +*Defined in [asset-buyer/src/types.ts:124](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L124)*
@@ -356,10 +587,6 @@ ___ - - - -
@@ -380,7 +607,7 @@ worstCaseQuoteInfo: Info about the worst case price for the asset. • **assetBuyAmount**: *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L48)* +*Defined in [asset-buyer/src/types.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L48)* ___ @@ -388,7 +615,7 @@ ___ • **assetData**: *string* -*Defined in [asset-buyer/src/types.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L47)* +*Defined in [asset-buyer/src/types.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L47)* ___ @@ -396,7 +623,7 @@ ___ • **bestCaseQuoteInfo**: *[BuyQuoteInfo](#class-buyquoteinfo)* -*Defined in [asset-buyer/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L52)* +*Defined in [asset-buyer/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L52)* ___ @@ -404,7 +631,7 @@ ___ • **feeOrders**: *`SignedOrder`[]* -*Defined in [asset-buyer/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L50)* +*Defined in [asset-buyer/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L50)* ___ @@ -412,7 +639,7 @@ ___ • **feePercentage**? : *undefined | number* -*Defined in [asset-buyer/src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L51)* +*Defined in [asset-buyer/src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L51)* ___ @@ -420,7 +647,7 @@ ___ • **orders**: *`SignedOrder`[]* -*Defined in [asset-buyer/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L49)* +*Defined in [asset-buyer/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L49)* ___ @@ -428,7 +655,7 @@ ___ • **worstCaseQuoteInfo**: *[BuyQuoteInfo](#class-buyquoteinfo)* -*Defined in [asset-buyer/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L53)* +*Defined in [asset-buyer/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L53)*
@@ -447,7 +674,7 @@ feeRecipient: The address where affiliate fees are sent. Defaults to null addres • **ethAmount**? : *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L93)* +*Defined in [asset-buyer/src/types.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L93)* ___ @@ -455,7 +682,7 @@ ___ • **feeRecipient**: *string* -*Defined in [asset-buyer/src/types.ts:97](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L97)* +*Defined in [asset-buyer/src/types.ts:97](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L97)* ___ @@ -463,7 +690,7 @@ ___ • **gasLimit**? : *undefined | number* -*Defined in [asset-buyer/src/types.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L95)* +*Defined in [asset-buyer/src/types.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L95)* ___ @@ -471,7 +698,7 @@ ___ • **gasPrice**? : *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:96](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L96)* +*Defined in [asset-buyer/src/types.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L96)* ___ @@ -479,7 +706,7 @@ ___ • **takerAddress**? : *undefined | string* -*Defined in [asset-buyer/src/types.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L94)* +*Defined in [asset-buyer/src/types.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L94)*
@@ -496,7 +723,7 @@ totalEthAmount: The total amount of eth required to complete the buy (filling or • **assetEthAmount**: *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:62](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L62)* +*Defined in [asset-buyer/src/types.ts:62](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L62)* ___ @@ -504,7 +731,7 @@ ___ • **feeEthAmount**: *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L63)* +*Defined in [asset-buyer/src/types.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L63)* ___ @@ -512,7 +739,7 @@ ___ • **totalEthAmount**: *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:64](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L64)* +*Defined in [asset-buyer/src/types.ts:64](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L64)*
@@ -529,7 +756,7 @@ slippagePercentage: The percentage buffer to add to account for slippage. Affect • **feePercentage**: *number* -*Defined in [asset-buyer/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L73)* +*Defined in [asset-buyer/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L73)* ___ @@ -537,7 +764,7 @@ ___ • **shouldForceOrderRefresh**: *boolean* -*Defined in [asset-buyer/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L74)* +*Defined in [asset-buyer/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L74)* ___ @@ -545,7 +772,7 @@ ___ • **slippagePercentage**: *number* -*Defined in [asset-buyer/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L75)* +*Defined in [asset-buyer/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L75)*
@@ -560,7 +787,7 @@ Represents available liquidity for a given assetData • **ethValueAvailableInWei**: *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:141](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L141)* +*Defined in [asset-buyer/src/types.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L141)* ___ @@ -568,7 +795,7 @@ ___ • **tokensAvailableInBaseUnits**: *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:140](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L140)* +*Defined in [asset-buyer/src/types.ts:140](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L140)*
@@ -682,7 +909,7 @@ ___ • **remainingFillableMakerAssetAmount**? : *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L26)* +*Defined in [asset-buyer/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L26)* ___ @@ -811,7 +1038,7 @@ Defined in types/lib/index.d.ts:19 • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -819,7 +1046,7 @@ Defined in types/lib/index.d.ts:19 ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -843,7 +1070,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -877,7 +1104,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/44793a9cf/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -901,7 +1128,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* ___ @@ -909,7 +1136,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* ___ @@ -917,7 +1144,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* ___ @@ -925,7 +1152,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)*
@@ -938,7 +1165,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* ___ @@ -946,7 +1173,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)*
@@ -959,7 +1186,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* ___ @@ -967,7 +1194,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* ___ @@ -975,7 +1202,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* ___ @@ -983,7 +1210,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
@@ -1044,7 +1271,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/44793a9cf/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -1060,7 +1287,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/44793a9cf/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -1086,7 +1313,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/44793a9cf/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -1112,7 +1339,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/44793a9cf/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -1138,7 +1365,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ @@ -1146,7 +1373,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ @@ -1154,7 +1381,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -1162,7 +1389,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -1172,7 +1399,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/44793a9cf/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -1189,7 +1416,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -1197,239 +1424,6 @@ ___ -# Class: AssetBuyer - - -## Constructors - - - -\+ **new AssetBuyer**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orderProvider`: [OrderProvider](#interface-orderprovider), `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* - -*Defined in [asset-buyer/src/asset_buyer.ts:83](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L83)* - -Instantiates a new AssetBuyer instance - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | -`orderProvider` | [OrderProvider](#interface-orderprovider) | - | An object that conforms to OrderProvider, see type for definition. | -`options` | `Partial` | {} | Initialization options for the AssetBuyer. See type definition for details. | - -**Returns:** *[AssetBuyer](#class-assetbuyer)* - -An instance of AssetBuyer - -## Properties - -### expiryBufferSeconds - -• **expiryBufferSeconds**: *number* - -*Defined in [asset-buyer/src/asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L40)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [asset-buyer/src/asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L38)* - -___ - -### orderProvider - -• **orderProvider**: *[OrderProvider](#interface-orderprovider)* - -*Defined in [asset-buyer/src/asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L37)* - -___ - -### orderRefreshIntervalMs - -• **orderRefreshIntervalMs**: *number* - -*Defined in [asset-buyer/src/asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L39)* - -___ - -### provider - -• **provider**: *`ZeroExProvider`* - -*Defined in [asset-buyer/src/asset_buyer.ts:36](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L36)* - -## Methods - -### executeBuyQuoteAsync - -▸ **executeBuyQuoteAsync**(`buyQuote`: [BuyQuote](#interface-buyquote), `options`: `Partial`): *`Promise`* - -*Defined in [asset-buyer/src/asset_buyer.ts:226](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L226)* - -Given a BuyQuote and desired rate, attempt to execute the buy. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`buyQuote` | [BuyQuote](#interface-buyquote) | - | An object that conforms to BuyQuote. See type definition for more information. | -`options` | `Partial` | {} | Options for the execution of the BuyQuote. See type definition for more information. | - -**Returns:** *`Promise`* - -A promise of the txHash. - -___ - -### getAvailableAssetDatasAsync - -▸ **getAvailableAssetDatasAsync**(): *`Promise`* - -*Defined in [asset-buyer/src/asset_buyer.ts:300](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L300)* - -Get the asset data of all assets that are purchaseable with ether token (wETH) in the order provider passed in at init. - -**Returns:** *`Promise`* - -An array of asset data strings that can be purchased using wETH. - -___ - -### getBuyQuoteAsync - -▸ **getBuyQuoteAsync**(`assetData`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* - -*Defined in [asset-buyer/src/asset_buyer.ts:125](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L125)* - -Get a `BuyQuote` containing all information relevant to fulfilling a buy given a desired assetData. -You can then pass the `BuyQuote` to `executeBuyQuoteAsync` to execute the buy. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | The assetData of the desired asset to buy (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | -`assetBuyAmount` | `BigNumber` | - | The amount of asset to buy. | -`options` | `Partial` | {} | Options for the request. See type definition for more information. | - -**Returns:** *`Promise`* - -An object that conforms to BuyQuote that satisfies the request. See type definition for more information. - -___ - -### getBuyQuoteForERC20TokenAddressAsync - -▸ **getBuyQuoteForERC20TokenAddressAsync**(`tokenAddress`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* - -*Defined in [asset-buyer/src/asset_buyer.ts:173](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L173)* - -Get a `BuyQuote` containing all information relevant to fulfilling a buy given a desired ERC20 token address. -You can then pass the `BuyQuote` to `executeBuyQuoteAsync` to execute the buy. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The ERC20 token address. | -`assetBuyAmount` | `BigNumber` | - | The amount of asset to buy. | -`options` | `Partial` | {} | Options for the request. See type definition for more information. | - -**Returns:** *`Promise`* - -An object that conforms to BuyQuote that satisfies the request. See type definition for more information. - -___ - -### getLiquidityForAssetDataAsync - -▸ **getLiquidityForAssetDataAsync**(`assetData`: string, `options`: `Partial`): *`Promise`* - -*Defined in [asset-buyer/src/asset_buyer.ts:192](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L192)* - -Returns information about available liquidity for an asset -Does not factor in slippage or fees - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | The assetData of the desired asset to buy (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | -`options` | `Partial` | {} | Options for the request. See type definition for more information. | - -**Returns:** *`Promise`* - -An object that conforms to LiquidityForAssetData that satisfies the request. See type definition for more information. - -___ - -### getOrdersAndFillableAmountsAsync - -▸ **getOrdersAndFillableAmountsAsync**(`assetData`: string, `shouldForceOrderRefresh`: boolean): *`Promise`* - -*Defined in [asset-buyer/src/asset_buyer.ts:309](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L309)* - -Grab orders from the map, if there is a miss or it is time to refresh, fetch and process the orders - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | The assetData of the desired asset to buy (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | -`shouldForceOrderRefresh` | boolean | If set to true, new orders and state will be fetched instead of waiting for the next orderRefreshIntervalMs. | - -**Returns:** *`Promise`* - -___ - -### `Static` getAssetBuyerForProvidedOrders - -▸ **getAssetBuyerForProvidedOrders**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orders`: `SignedOrder`[], `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* - -*Defined in [asset-buyer/src/asset_buyer.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L53)* - -Instantiates a new AssetBuyer instance given existing liquidity in the form of orders and feeOrders. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | -`orders` | `SignedOrder`[] | - | A non-empty array of objects that conform to SignedOrder. All orders must have the same makerAssetData and takerAssetData (WETH). | -`options` | `Partial` | {} | Initialization options for the AssetBuyer. See type definition for details. | - -**Returns:** *[AssetBuyer](#class-assetbuyer)* - -An instance of AssetBuyer - -___ - -### `Static` getAssetBuyerForStandardRelayerAPIUrl - -▸ **getAssetBuyerForStandardRelayerAPIUrl**(`supportedProvider`: [SupportedProvider](#supportedprovider), `sraApiUrl`: string, `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* - -*Defined in [asset-buyer/src/asset_buyer.ts:72](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/asset_buyer.ts#L72)* - -Instantiates a new AssetBuyer instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | -`sraApiUrl` | string | - | The standard relayer API base HTTP url you would like to source orders from. | -`options` | `Partial` | {} | Initialization options for the AssetBuyer. See type definition for details. | - -**Returns:** *[AssetBuyer](#class-assetbuyer)* - -An instance of AssetBuyer - -
- @@ -1527,8 +1521,6 @@ An instance of AssetBuyer - - @@ -1543,7 +1535,7 @@ An instance of AssetBuyer *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* ___ @@ -1553,7 +1545,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -1563,7 +1555,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -1573,7 +1565,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -1583,7 +1575,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -1593,7 +1585,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -1603,7 +1595,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -1613,7 +1605,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* ___ @@ -1623,7 +1615,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -1633,7 +1625,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -1643,7 +1635,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -1651,7 +1643,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -1661,7 +1653,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -1671,7 +1663,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -1681,7 +1673,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -1691,7 +1683,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* ___ @@ -1701,7 +1693,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -1733,33 +1725,6 @@ ___ - - - - - - - - - - - - - - - - - - - - - -## Type aliases - - - - - @@ -1803,7 +1768,7 @@ ___ Ƭ **LiquidityRequestOpts**: *`Pick`* -*Defined in [asset-buyer/src/types.ts:83](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-buyer/src/types.ts#L83)* +*Defined in [asset-buyer/src/types.ts:83](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-buyer/src/types.ts#L83)*
@@ -1828,7 +1793,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1845,7 +1810,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -1874,7 +1839,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/44793a9cf/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -1889,7 +1854,38 @@ ___ Ƭ **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/44793a9cf/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)* + +
+ + + + +## Type aliases + + + + + + + + + + + + + + + + + + + + + + + +
diff --git a/packages/asset-swapper/CHANGELOG.json b/packages/asset-swapper/CHANGELOG.json index b2dcdc7c6d..96f2a7801f 100644 --- a/packages/asset-swapper/CHANGELOG.json +++ b/packages/asset-swapper/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.1.0-beta.0", "changes": [ diff --git a/packages/asset-swapper/CHANGELOG.md b/packages/asset-swapper/CHANGELOG.md index 66b84b557f..6104cb491c 100644 --- a/packages/asset-swapper/CHANGELOG.md +++ b/packages/asset-swapper/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/asset-swapper/docs/reference.mdx b/packages/asset-swapper/docs/reference.mdx index 8fffb7e30b..7ebf9fa69b 100644 --- a/packages/asset-swapper/docs/reference.mdx +++ b/packages/asset-swapper/docs/reference.mdx @@ -1,2484 +1,3 @@ -# Interface: TupleDataItem - - -## Properties - -### components - -• **components**: *[DataItem](#class-dataitem)[]* - -*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* - -*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L141)* - -___ - -### name - -• **name**: *string* - -*Inherited from [DataItem](#interface-dataitem).[name](#name)* - -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* - -___ - -### type - -• **type**: *string* - -*Inherited from [DataItem](#interface-dataitem).[type](#type)* - -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* - -
- -# Class: SwapQuoteConsumer - - -## Implements - -* [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)‹*[SmartContractParams](#smartcontractparams)*› - - -## Constructors - - - -\+ **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/44793a9cf/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L31)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`options` | `Partial` | {} | - -**Returns:** *[SwapQuoteConsumer](#class-swapquoteconsumer)* - -## Properties - -### networkId - -• **networkId**: *number* - -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L27)* - -___ - -### provider - -• **provider**: *`ZeroExProvider`* - -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L26)* - -## Methods - -### executeSwapQuoteOrThrowAsync - -▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:81](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L81)* - -Given a SwapQuote and desired rate (in takerAsset), attempt to execute the swap. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`quote` | [SwapQuote](#swapquote) | - | An object that conforms to SwapQuote. See type definition for more information. | -`opts` | `Partial` | {} | Options for getting CalldataInfo. See type definition for more information. | - -**Returns:** *`Promise`* - -___ - -### getCalldataOrThrowAsync - -▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`quote` | [SwapQuote](#swapquote) | - | An object that conforms to SwapQuote. See type definition for more information. | -`opts` | `Partial` | {} | Options for getting SmartContractParams. See type definition for more information. | - -**Returns:** *`Promise`* - -___ - -### getOptimalExtensionContractTypeAsync - -▸ **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/44793a9cf/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L90)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`quote` | [SwapQuote](#swapquote) | - | -`opts` | `Partial` | {} | - -**Returns:** *`Promise`* - -___ - -### getSmartContractParamsOrThrowAsync - -▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:67](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`quote` | [SwapQuote](#swapquote) | - | An object that conforms to SwapQuote. See type definition for more information. | -`opts` | `Partial` | {} | Options for getting SmartContractParams. See type definition for more information. | - -**Returns:** *`Promise>`* - -
- -# Class: SwapQuoter - - -## Constructors - - - -\+ **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/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L126)* - -Instantiates a new SwapQuoter instance - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | -`orderbook` | `Orderbook` | - | An object that conforms to Orderbook, see type for definition. | -`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | - -**Returns:** *[SwapQuoter](#class-swapquoter)* - -An instance of SwapQuoter - -## Properties - -### expiryBufferMs - -• **expiryBufferMs**: *number* - -*Defined in [asset-swapper/src/swap_quoter.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L30)* - -___ - -### orderbook - -• **orderbook**: *`Orderbook`* - -*Defined in [asset-swapper/src/swap_quoter.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L29)* - -___ - -### provider - -• **provider**: *`ZeroExProvider`* - -*Defined in [asset-swapper/src/swap_quoter.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L28)* - -## Methods - -### destroyAsync - -▸ **destroyAsync**(): *`Promise`* - -*Defined in [asset-swapper/src/swap_quoter.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L391)* - -Destroys any subscriptions or connections. - -**Returns:** *`Promise`* - -___ - -### getAvailableMakerAssetDatasAsync - -▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* - -*Defined in [asset-swapper/src/swap_quoter.ts:309](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L309)* - -Get the asset data of all assets that are purchaseable with takerAssetData in the order provider passed in at init. - -**Parameters:** - -Name | Type | ------- | ------ | -`takerAssetData` | string | - -**Returns:** *`Promise`* - -An array of asset data strings that are purchaseable with takerAssetData. - -___ - -### getAvailableTakerAssetDatasAsync - -▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise`* - -*Defined in [asset-swapper/src/swap_quoter.ts:294](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L294)* - -Get the asset data of all assets that can be used to purchase makerAssetData in the order provider passed in at init. - -**Parameters:** - -Name | Type | ------- | ------ | -`makerAssetData` | string | - -**Returns:** *`Promise`* - -An array of asset data strings that can purchase makerAssetData. - -___ - -### getLiquidityForMakerTakerAssetDataPairAsync - -▸ **getLiquidityForMakerTakerAssetDataPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* - -*Defined in [asset-swapper/src/swap_quoter.ts:268](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L268)* - -Returns information about available liquidity for an asset -Does not factor in slippage or fees - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`makerAssetData` | string | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | -`takerAssetData` | string | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | - -**Returns:** *`Promise`* - -An object that conforms to LiquidityForAssetData that satisfies the request. See type definition for more information. - -___ - -### getMarketBuySwapQuoteAsync - -▸ **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/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L210)* - -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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`makerTokenAddress` | string | - | The address of the maker asset | -`takerTokenAddress` | string | - | The address of the taker asset | -`makerAssetBuyAmount` | `BigNumber` | - | The amount of maker asset to swap for. | -`options` | `Partial` | {} | Options for the request. See type definition for more information. | - -**Returns:** *`Promise`* - -An object that conforms to SwapQuote that satisfies the request. See type definition for more information. - -___ - -### getMarketBuySwapQuoteForAssetDataAsync - -▸ **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/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L185)* - -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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`makerAssetData` | string | - | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | -`takerAssetData` | string | - | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | -`makerAssetBuyAmount` | `BigNumber` | - | The amount of maker asset to swap for. | -`options` | `Partial` | {} | Options for the request. See type definition for more information. | - -**Returns:** *`Promise`* - -An object that conforms to SwapQuote that satisfies the request. See type definition for more information. - -___ - -### getMarketSellSwapQuoteAsync - -▸ **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/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L240)* - -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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`makerTokenAddress` | string | - | The address of the maker asset | -`takerTokenAddress` | string | - | The address of the taker asset | -`takerAssetSellAmount` | `BigNumber` | - | The amount of taker asset to sell. | -`options` | `Partial` | {} | Options for the request. See type definition for more information. | - -**Returns:** *`Promise`* - -An object that conforms to SwapQuote that satisfies the request. See type definition for more information. - -___ - -### getMarketSellSwapQuoteForAssetDataAsync - -▸ **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/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L159)* - -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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`makerAssetData` | string | - | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | -`takerAssetData` | string | - | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | -`takerAssetSellAmount` | `BigNumber` | - | The amount of taker asset to swap for. | -`options` | `Partial` | {} | Options for the request. See type definition for more information. | - -**Returns:** *`Promise`* - -An object that conforms to SwapQuote that satisfies the request. See type definition for more information. - -___ - -### getOrdersAndFillableAmountsAsync - -▸ **getOrdersAndFillableAmountsAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* - -*Defined in [asset-swapper/src/swap_quoter.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L341)* - -Grab orders from the map, if there is a miss or it is time to refresh, fetch and process the orders - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`makerAssetData` | string | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | -`takerAssetData` | string | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | - -**Returns:** *`Promise`* - -___ - -### isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync - -▸ **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/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L372)* - -Util function to check if takerAddress's allowance is enough for 0x exchange contracts to conduct the swap specified by the swapQuote. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`swapQuote` | [SwapQuote](#swapquote) | The swapQuote in question to check enough allowance enabled for 0x exchange contracts to conduct the swap. | -`takerAddress` | string | The address of the taker of the provided swapQuote | - -**Returns:** *`Promise<[boolean, boolean]>`* - -___ - -### isTakerMakerAssetDataPairAvailableAsync - -▸ **isTakerMakerAssetDataPairAvailableAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* - -*Defined in [asset-swapper/src/swap_quoter.ts:324](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L324)* - -Validates the taker + maker asset pair is available from the order provider provided to `SwapQuote`. - -**Parameters:** - -Name | Type | ------- | ------ | -`makerAssetData` | string | -`takerAssetData` | string | - -**Returns:** *`Promise`* - -A boolean on if the taker, maker pair exists - -___ - -### `Static` getSwapQuoterForMeshEndpoint - -▸ **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/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L113)* - -Instantiates a new SwapQuoter instance given a 0x Mesh endpoint. This pulls all available liquidity stored in Mesh - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | -`meshEndpoint` | string | - | The standard relayer API base HTTP url you would like to source orders from. | -`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | - -**Returns:** *[SwapQuoter](#class-swapquoter)* - -An instance of SwapQuoter - -___ - -### `Static` getSwapQuoterForProvidedOrders - -▸ **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/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L41)* - -Instantiates a new SwapQuoter instance given existing liquidity in the form of orders and feeOrders. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | -`orders` | `SignedOrder`[] | - | A non-empty array of objects that conform to SignedOrder. All orders must have the same makerAssetData and takerAssetData. | -`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | - -**Returns:** *[SwapQuoter](#class-swapquoter)* - -An instance of SwapQuoter - -___ - -### `Static` getSwapQuoterForStandardRelayerAPIUrl - -▸ **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/44793a9cf/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 - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | -`sraApiUrl` | string | - | The standard relayer API base HTTP url you would like to source orders from. | -`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | - -**Returns:** *[SwapQuoter](#class-swapquoter)* - -An instance of SwapQuoter - -___ - -### `Static` getSwapQuoterForStandardRelayerAPIWebsocket - -▸ **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/44793a9cf/packages/asset-swapper/src/swap_quoter.ts#L88)* - -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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | -`sraApiUrl` | string | - | The standard relayer API base HTTP url you would like to source orders from. | -`sraWebsocketAPIUrl` | string | - | - | -`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | - -**Returns:** *[SwapQuoter](#class-swapquoter)* - -An instance of SwapQuoter - -
- -# Class: BaseOrderProvider - - -## Constructors - - - -\+ **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/44793a9cf/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderStore` | [OrderStore](#class-orderstore) | - -**Returns:** *[BaseOrderProvider](#class-baseorderprovider)* - -## Properties - -### _orderStore - -• **_orderStore**: *[OrderStore](#class-orderstore)* - -*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* - -## Methods - -### `Abstract` addOrdersAsync - -▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* - -*Defined in [orderbook/src/order_provider/base_order_provider.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_provider/base_order_provider.ts#L27)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `SignedOrder`[] | - -**Returns:** *`Promise`* - -___ - -### `Abstract` createSubscriptionForAssetPairAsync - -▸ **createSubscriptionForAssetPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* - -*Defined in [orderbook/src/order_provider/base_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_provider/base_order_provider.ts#L18)* - -**Parameters:** - -Name | Type | ------- | ------ | -`makerAssetData` | string | -`takerAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` destroyAsync - -▸ **destroyAsync**(): *`Promise`* - -*Defined in [orderbook/src/order_provider/base_order_provider.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_provider/base_order_provider.ts#L25)* - -**Returns:** *`Promise`* - -___ - -### `Abstract` getAvailableAssetDatasAsync - -▸ **getAvailableAssetDatasAsync**(): *`Promise`* - -*Defined in [orderbook/src/order_provider/base_order_provider.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_provider/base_order_provider.ts#L23)* - -**Returns:** *`Promise`* - -
- -# Class: OrderSet - - -## Constructors - - - -\+ **new OrderSet**(`orders`: `APIOrder`[]): *[OrderSet](#class-orderset)* - -*Defined in [orderbook/src/order_set.ts:6](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_set.ts#L6)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`orders` | `APIOrder`[] | [] | - -**Returns:** *[OrderSet](#class-orderset)* - -## Methods - -### add - -▸ **add**(`item`: `APIOrder`): *void* - -*Defined in [orderbook/src/order_set.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_set.ts#L19)* - -**Parameters:** - -Name | Type | ------- | ------ | -`item` | `APIOrder` | - -**Returns:** *void* - -___ - -### addMany - -▸ **addMany**(`items`: `APIOrder`[]): *void* - -*Defined in [orderbook/src/order_set.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_set.ts#L25)* - -**Parameters:** - -Name | Type | ------- | ------ | -`items` | `APIOrder`[] | - -**Returns:** *void* - -___ - -### delete - -▸ **delete**(`item`: `APIOrder`): *boolean* - -*Defined in [orderbook/src/order_set.ts:57](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_set.ts#L57)* - -**Parameters:** - -Name | Type | ------- | ------ | -`item` | `APIOrder` | - -**Returns:** *boolean* - -___ - -### deleteMany - -▸ **deleteMany**(`items`: `APIOrder`[]): *void* - -*Defined in [orderbook/src/order_set.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_set.ts#L61)* - -**Parameters:** - -Name | Type | ------- | ------ | -`items` | `APIOrder`[] | - -**Returns:** *void* - -___ - -### diff - -▸ **diff**(`other`: [OrderSet](#class-orderset)): *object* - -*Defined in [orderbook/src/order_set.ts:35](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_set.ts#L35)* - -**Parameters:** - -Name | Type | ------- | ------ | -`other` | [OrderSet](#class-orderset) | - -**Returns:** *object* - -___ - -### has - -▸ **has**(`order`: `APIOrder`): *boolean* - -*Defined in [orderbook/src/order_set.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_set.ts#L31)* - -**Parameters:** - -Name | Type | ------- | ------ | -`order` | `APIOrder` | - -**Returns:** *boolean* - -___ - -### size - -▸ **size**(): *number* - -*Defined in [orderbook/src/order_set.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_set.ts#L15)* - -**Returns:** *number* - -___ - -### values - -▸ **values**(): *`IterableIterator`* - -*Defined in [orderbook/src/order_set.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_set.ts#L53)* - -**Returns:** *`IterableIterator`* - -
- -# Class: OrderStore - - -## Methods - -### getOrderSetForAssetPair - -▸ **getOrderSetForAssetPair**(`assetPairKey`: string): *[OrderSet](#class-orderset)* - -*Defined in [orderbook/src/order_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_store.ts#L19)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetPairKey` | string | - -**Returns:** *[OrderSet](#class-orderset)* - -___ - -### getOrderSetForAssets - -▸ **getOrderSetForAssets**(`makerAssetData`: string, `takerAssetData`: string): *[OrderSet](#class-orderset)* - -*Defined in [orderbook/src/order_store.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_store.ts#L15)* - -**Parameters:** - -Name | Type | ------- | ------ | -`makerAssetData` | string | -`takerAssetData` | string | - -**Returns:** *[OrderSet](#class-orderset)* - -___ - -### has - -▸ **has**(`assetPairKey`: string): *boolean* - -*Defined in [orderbook/src/order_store.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_store.ts#L34)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetPairKey` | string | - -**Returns:** *boolean* - -___ - -### keys - -▸ **keys**(): *`IterableIterator`* - -*Defined in [orderbook/src/order_store.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_store.ts#L40)* - -**Returns:** *`IterableIterator`* - -___ - -### update - -▸ **update**(`addedRemoved`: [AddedRemovedOrders](#interface-addedremovedorders)): *void* - -*Defined in [orderbook/src/order_store.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_store.ts#L28)* - -**Parameters:** - -Name | Type | ------- | ------ | -`addedRemoved` | [AddedRemovedOrders](#interface-addedremovedorders) | - -**Returns:** *void* - -___ - -### values - -▸ **values**(`assetPairKey`: string): *`APIOrder`[]* - -*Defined in [orderbook/src/order_store.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_store.ts#L37)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetPairKey` | string | - -**Returns:** *`APIOrder`[]* - -___ - -### `Static` assetPairKeyToAssets - -▸ **assetPairKeyToAssets**(`assetPairKey`: string): *string[]* - -*Defined in [orderbook/src/order_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_store.ts#L12)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetPairKey` | string | - -**Returns:** *string[]* - -___ - -### `Static` getKeyForAssetPair - -▸ **getKeyForAssetPair**(`makerAssetData`: string, `takerAssetData`: string): *string* - -*Defined in [orderbook/src/order_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/order_store.ts#L9)* - -**Parameters:** - -Name | Type | ------- | ------ | -`makerAssetData` | string | -`takerAssetData` | string | - -**Returns:** *string* - -
- -# Class: Orderbook - - -## Constructors - - - -\+ **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/44793a9cf/packages/orderbook/src/orderbook.ts#L55)* - -Creates an Orderbook with the order provider. All order updates are stored -in the `OrderStore`. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderProvider` | [BaseOrderProvider](#class-baseorderprovider) | the order provider, e.g SRAWebbsocketOrderProvider | -`orderStore` | [OrderStore](#class-orderstore) | the order store where orders are added and deleted | - -**Returns:** *[Orderbook](#class-orderbook)* - -## Methods - -### addOrdersAsync - -▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* - -*Defined in [orderbook/src/orderbook.ts:98](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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 - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | The set of Orders to add to the Order Provider | - -**Returns:** *`Promise`* - -___ - -### destroyAsync - -▸ **destroyAsync**(): *`Promise`* - -*Defined in [orderbook/src/orderbook.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/orderbook.ts#L104)* - -Destroys any subscriptions or connections. - -**Returns:** *`Promise`* - -___ - -### getAvailableAssetDatasAsync - -▸ **getAvailableAssetDatasAsync**(): *`Promise`* - -*Defined in [orderbook/src/orderbook.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/orderbook.ts#L90)* - -Returns all of the Available Asset Pairs for the provided Order Provider. - -**Returns:** *`Promise`* - -___ - -### getOrdersAsync - -▸ **getOrdersAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* - -*Defined in [orderbook/src/orderbook.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/orderbook.ts#L75)* - -Returns all orders where the order.makerAssetData == makerAssetData and -order.takerAssetData == takerAssetData. This pair is then subscribed to -and all future updates will be stored. The first request -to `getOrdersAsync` might fetch the orders from the Order Provider and create a subscription. -Subsequent requests will be quick and up to date and synced with the Order Provider state. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`makerAssetData` | string | the maker asset data | -`takerAssetData` | string | the taker asset data | - -**Returns:** *`Promise`* - -___ - -### `Static` getOrderbookForMeshProvider - -▸ **getOrderbookForMeshProvider**(`opts`: [MeshOrderProviderOpts](#interface-meshorderprovideropts)): *[Orderbook](#class-orderbook)* - -*Defined in [orderbook/src/orderbook.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`opts` | [MeshOrderProviderOpts](#interface-meshorderprovideropts) | the `MeshOrderProviderOpts` | - -**Returns:** *[Orderbook](#class-orderbook)* - -___ - -### `Static` getOrderbookForPollingProvider - -▸ **getOrderbookForPollingProvider**(`opts`: [SRAPollingOrderProviderOpts](#interface-srapollingorderprovideropts)): *[Orderbook](#class-orderbook)* - -*Defined in [orderbook/src/orderbook.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/orderbook.ts#L43)* - -Creates an Orderbook with SRA Polling Provider. This Provider simply polls every interval. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`opts` | [SRAPollingOrderProviderOpts](#interface-srapollingorderprovideropts) | the `SRAPollingOrderProviderOpts` | - -**Returns:** *[Orderbook](#class-orderbook)* - -___ - -### `Static` getOrderbookForProvidedOrders - -▸ **getOrderbookForProvidedOrders**(`orders`: `SignedOrder`[]): *[Orderbook](#class-orderbook)* - -*Defined in [orderbook/src/orderbook.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | the set of SignedOrders | - -**Returns:** *[Orderbook](#class-orderbook)* - -___ - -### `Static` getOrderbookForWebsocketProvider - -▸ **getOrderbookForWebsocketProvider**(`opts`: [SRAWebsocketOrderProviderOpts](#interface-srawebsocketorderprovideropts)): *[Orderbook](#class-orderbook)* - -*Defined in [orderbook/src/orderbook.ts:35](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`opts` | [SRAWebsocketOrderProviderOpts](#interface-srawebsocketorderprovideropts) | the `SRAWebsocketOrderProviderOpts` | - -**Returns:** *[Orderbook](#class-orderbook)* - -
- -# Enumeration: ExtensionContractType - -Represents the varying smart contracts that can consume a valid swap quote - - -## Enumeration members - -### Forwarder - -• **Forwarder**: = "FORWARDER" - -*Defined in [asset-swapper/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L90)* - -___ - -### None - -• **None**: = "NONE" - -*Defined in [asset-swapper/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L91)* - -
- - - -# Enumeration: SwapQuoterError - -Possible error messages thrown by an SwapQuoter instance or associated static methods. - - -## Enumeration members - -### AssetUnavailable - -• **AssetUnavailable**: = "ASSET_UNAVAILABLE" - -*Defined in [asset-swapper/src/types.ts:305](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L305)* - -___ - -### FeeAssetUnavailable - -• **FeeAssetUnavailable**: = "FEE_ASSET_UNAVAILABLE" - -*Defined in [asset-swapper/src/types.ts:306](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L306)* - -___ - -### InsufficientAssetLiquidity - -• **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" - -*Defined in [asset-swapper/src/types.ts:302](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L302)* - -___ - -### InsufficientZrxLiquidity - -• **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY" - -*Defined in [asset-swapper/src/types.ts:303](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L303)* - -___ - -### InvalidOrderProviderResponse - -• **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE" - -*Defined in [asset-swapper/src/types.ts:304](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L304)* - -___ - -### NoEtherTokenContractFound - -• **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND" - -*Defined in [asset-swapper/src/types.ts:299](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L299)* - -___ - -### NoZrxTokenContractFound - -• **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND" - -*Defined in [asset-swapper/src/types.ts:300](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L300)* - -___ - -### StandardRelayerApiError - -• **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR" - -*Defined in [asset-swapper/src/types.ts:301](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L301)* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -# Interface: CalldataInfo - -Represents the metadata to call a smart contract with calldata. -calldataHexString: The hexstring of the calldata. -methodAbi: The ABI of the smart contract method to call. -toAddress: The contract address to call. -ethAmount: If provided, the eth amount in wei to send with the smart contract call. - - -## Properties - -### calldataHexString - -• **calldataHexString**: *string* - -*Defined in [asset-swapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L39)* - -___ - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L42)* - -___ - -### methodAbi - -• **methodAbi**: *`MethodAbi`* - -*Defined in [asset-swapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L40)* - -___ - -### toAddress - -• **toAddress**: *string* - -*Defined in [asset-swapper/src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L41)* - -
- - - - - - - - - - - -# Interface: ForwarderSwapQuoteExecutionOpts - - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)* - -*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L181)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)* - -*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L179)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)* - -*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L180)* - -___ - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasLimit](#optional-gaslimit)* - -*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L169)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasPrice](#optional-gasprice)* - -*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L170)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[takerAddress](#optional-takeraddress)* - -*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L168)* - -
- -# Interface: ForwarderSwapQuoteGetOutputOpts - -feePercentage: percentage (up to 5%) of the taker asset paid to feeRecipient -feeRecipient: address of the receiver of the feePercentage of taker asset -ethAmount: The amount of eth (in Wei) sent to the forwarder contract. - - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L181)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L179)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L180)* - -
- -# Interface: GetExtensionContractTypeOpts - - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:188](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L188)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Defined in [asset-swapper/src/types.ts:187](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L187)* - -
- -# Interface: LiquidityForAssetData - -Represents available liquidity for a given assetData - - -## Properties - -### makerTokensAvailableInBaseUnits - -• **makerTokensAvailableInBaseUnits**: *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:322](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L322)* - -___ - -### takerTokensAvailableInBaseUnits - -• **takerTokensAvailableInBaseUnits**: *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:323](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L323)* - -
- -# Interface: MarketBuySwapQuote - -makerAssetFillAmount: The amount of makerAsset bought with takerAsset. -type: Specified MarketOperation the SwapQuote is provided for - - -## Properties - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* - -*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L219)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* - -*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L218)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* - -*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L216)* - -___ - -### makerAssetFillAmount - -• **makerAssetFillAmount**: *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:237](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L237)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* - -*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L217)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* - -*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L215)* - -___ - -### type - -• **type**: *`Buy`* - -*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L238)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* - -*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L220)* - -
- -# Interface: MarketBuySwapQuoteWithAffiliateFee - - -## Properties - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* - -*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L219)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* - -*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L218)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase).[feePercentage](#feepercentage)* - -*Defined in [asset-swapper/src/types.ts:242](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L242)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* - -*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L216)* - -___ - -### makerAssetFillAmount - -• **makerAssetFillAmount**: *`BigNumber`* - -*Inherited from [MarketBuySwapQuote](#interface-marketbuyswapquote).[makerAssetFillAmount](#makerassetfillamount)* - -*Defined in [asset-swapper/src/types.ts:237](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L237)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* - -*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L217)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* - -*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L215)* - -___ - -### type - -• **type**: *`Buy`* - -*Inherited from [MarketBuySwapQuote](#interface-marketbuyswapquote).[type](#type)* - -*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L238)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* - -*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L220)* - -
- -# Interface: MarketSellSwapQuote - -takerAssetFillAmount: The amount of takerAsset sold for makerAsset. -type: Specified MarketOperation the SwapQuote is provided for - - -## Properties - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* - -*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L219)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* - -*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L218)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* - -*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L216)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* - -*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L217)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* - -*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L215)* - -___ - -### takerAssetFillAmount - -• **takerAssetFillAmount**: *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:228](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L228)* - -___ - -### type - -• **type**: *`Sell`* - -*Defined in [asset-swapper/src/types.ts:229](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L229)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* - -*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L220)* - -
- -# Interface: MarketSellSwapQuoteWithAffiliateFee - - -## Properties - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* - -*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L219)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* - -*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L218)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase).[feePercentage](#feepercentage)* - -*Defined in [asset-swapper/src/types.ts:242](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L242)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* - -*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L216)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* - -*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L217)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* - -*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L215)* - -___ - -### takerAssetFillAmount - -• **takerAssetFillAmount**: *`BigNumber`* - -*Inherited from [MarketSellSwapQuote](#interface-marketsellswapquote).[takerAssetFillAmount](#takerassetfillamount)* - -*Defined in [asset-swapper/src/types.ts:228](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L228)* - -___ - -### type - -• **type**: *`Sell`* - -*Inherited from [MarketSellSwapQuote](#interface-marketsellswapquote).[type](#type)* - -*Defined in [asset-swapper/src/types.ts:229](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L229)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* - -*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L220)* - -
- - - - - - - - - - - -# Interface: SmartContractParamsInfo <**T**> - -Represents the metadata to call a smart contract with parameters. -params: The metadata object containing all the input parameters of a smart contract call. -toAddress: The contract address to call. -ethAmount: If provided, the eth amount in wei to send with the smart contract call. -methodAbi: The ABI of the smart contract method to call with params. - -## Type parameters - -▪ **T** - - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L55)* - -___ - -### methodAbi - -• **methodAbi**: *`MethodAbi`* - -*Defined in [asset-swapper/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L56)* - -___ - -### params - -• **params**: *`T`* - -*Defined in [asset-swapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L53)* - -___ - -### toAddress - -• **toAddress**: *string* - -*Defined in [asset-swapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L54)* - -
- - - -# Interface: SwapQuoteConsumerBase <**T**> - -Interface that varying SwapQuoteConsumers adhere to (exchange consumer, router consumer, forwarder consumer, coordinator consumer) -getCalldataOrThrow: Get CalldataInfo to swap for tokens with provided SwapQuote. Throws if invalid SwapQuote is provided. -getSmartContractParamsOrThrow: Get SmartContractParamsInfo to swap for tokens with provided SwapQuote. Throws if invalid SwapQuote is provided. -executeSwapQuoteOrThrowAsync: Executes a web3 transaction to swap for tokens with provided SwapQuote. Throws if invalid SwapQuote is provided. - -## Type parameters - -▪ **T** - - -## Implemented by - -* [SwapQuoteConsumer](#class-swapquoteconsumer) - - -## Methods - -### executeSwapQuoteOrThrowAsync - -▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Defined in [asset-swapper/src/types.ts:147](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L147)* - -**Parameters:** - -Name | Type | ------- | ------ | -`quote` | [SwapQuote](#swapquote) | -`opts` | `Partial` | - -**Returns:** *`Promise`* - -___ - -### getCalldataOrThrowAsync - -▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Defined in [asset-swapper/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L142)* - -**Parameters:** - -Name | Type | ------- | ------ | -`quote` | [SwapQuote](#swapquote) | -`opts` | `Partial` | - -**Returns:** *`Promise`* - -___ - -### getSmartContractParamsOrThrowAsync - -▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* - -*Defined in [asset-swapper/src/types.ts:143](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L143)* - -**Parameters:** - -Name | Type | ------- | ------ | -`quote` | [SwapQuote](#swapquote) | -`opts` | `Partial` | - -**Returns:** *`Promise>`* - -
- -# Interface: SwapQuoteConsumerOpts - -networkId: The networkId that the desired orders should be for. - - -## Properties - -### networkId - -• **networkId**: *number* - -*Defined in [asset-swapper/src/types.ts:154](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L154)* - -
- -# Interface: SwapQuoteExecutionOpts - -Represents the options for executing a swap quote with SwapQuoteConsumer - - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)* - -*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/44793a9cf/packages/asset-swapper/src/types.ts#L181)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)* - -*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/44793a9cf/packages/asset-swapper/src/types.ts#L179)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)* - -*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/44793a9cf/packages/asset-swapper/src/types.ts#L180)* - -___ - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasLimit](#optional-gaslimit)* - -*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L169)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasPrice](#optional-gasprice)* - -*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L170)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[takerAddress](#optional-takeraddress)* - -*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L168)* - -___ - -### useExtensionContract - -• **useExtensionContract**: *[ExtensionContractType](#enumeration-extensioncontracttype)* - -*Inherited from [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts).[useExtensionContract](#useextensioncontract)* - -*Defined in [asset-swapper/src/types.ts:196](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L196)* - -
- -# Interface: SwapQuoteExecutionOptsBase - -takerAddress: The address to perform the buy. Defaults to the first available address from the provider. -gasLimit: The amount of gas to send with a transaction (in Gwei). Defaults to an eth_estimateGas rpc call. -gasPrice: Gas price in Wei to use for a transaction - - -## Properties - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L169)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L170)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L168)* - -
- -# Interface: SwapQuoteGetOutputOpts - -takerAddress: The address to perform the buy. Defaults to the first available address from the provider. -useConsumerType: If provided, defaults the SwapQuoteConsumer to create output consumed by ConsumerType. - - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)* - -*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L181)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)* - -*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L179)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)* - -*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L180)* - -___ - -### useExtensionContract - -• **useExtensionContract**: *[ExtensionContractType](#enumeration-extensioncontracttype)* - -*Defined in [asset-swapper/src/types.ts:196](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L196)* - -
- -# Interface: SwapQuoteGetOutputOptsBase - -Represents the options provided to a generic SwapQuoteConsumer - - -## Hierarchy - -* **SwapQuoteInfo** - - -## Properties - -### feeTakerTokenAmount - -• **feeTakerTokenAmount**: *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:258](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L258)* - -___ - -### makerTokenAmount - -• **makerTokenAmount**: *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:261](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L261)* - -___ - -### takerTokenAmount - -• **takerTokenAmount**: *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:260](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L260)* - -___ - -### totalTakerTokenAmount - -• **totalTakerTokenAmount**: *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:259](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L259)* - -
- -# Interface: SwapQuoteRequestOpts - -shouldDisableRequestingFeeOrders: If set to true, requesting a swapQuote will not perform any computation or requests for fees. -slippagePercentage: The percentage buffer to add to account for slippage. Affects max ETH price estimates. Defaults to 0.2 (20%). - - -## Properties - -### shouldDisableRequestingFeeOrders - -• **shouldDisableRequestingFeeOrders**: *boolean* - -*Defined in [asset-swapper/src/types.ts:269](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L269)* - -___ - -### slippagePercentage - -• **slippagePercentage**: *number* - -*Defined in [asset-swapper/src/types.ts:270](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L270)* - -
- -# Interface: SwapQuoterOpts - -networkId: The ethereum network id. Defaults to 1 (mainnet). -orderRefreshIntervalMs: The interval in ms that getBuyQuoteAsync should trigger an refresh of orders and order states. Defaults to 10000ms (10s). -expiryBufferMs: The number of seconds to add when calculating whether an order is expired or not. Defaults to 300s (5m). - - -## Properties - -### expiryBufferMs - -• **expiryBufferMs**: *number* - -*Defined in [asset-swapper/src/types.ts:281](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L281)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [asset-swapper/src/types.ts:279](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L279)* - -___ - -### orderRefreshIntervalMs - -• **orderRefreshIntervalMs**: *number* - -*Defined in [asset-swapper/src/types.ts:280](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L280)* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -# Interface: DataItem - - -## Properties - -### `Optional` components - -• **components**? : *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)* - -___ - -### name - -• **name**: *string* - -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* - -
- - - - - - - -# Interface: EIP1193Provider - - -## Properties - -### isEIP1193 - -• **isEIP1193**: *boolean* - -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)* - -## Methods - -### on - -▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* - -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)* - -**Parameters:** - -▪ **event**: *[EIP1193Event](#eip1193event)* - -▪ **listener**: *function* - -▸ (`result`: any): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`result` | any | - -**Returns:** *this* - -___ - -### send - -▸ **send**(`method`: string, `params?`: any[]): *`Promise`* - -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)* - -**Parameters:** - -Name | Type | ------- | ------ | -`method` | string | -`params?` | any[] | - -**Returns:** *`Promise`* - -
- - - - - - - - - - - - - -# 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/44793a9cf/packages/ethereum-types/src/index.ts#L14)* - -**Parameters:** - -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | - -**Returns:** *void* - -
- - - -# Interface: JSONRPCRequestPayload - - -## Properties - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* - -___ - -### method - -• **method**: *string* - -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* - -___ - -### params - -• **params**: *any[]* - -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* - -
- -# Interface: JSONRPCResponseError - - -## Properties - -### code - -• **code**: *number* - -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* - -___ - -### message - -• **message**: *string* - -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* - -
- -# Interface: JSONRPCResponsePayload - - -## Properties - -### `Optional` error - -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* - -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* - -___ - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* - -___ - -### result - -• **result**: *any* - -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* - -
- - - - - - - -# Interface: MethodAbi - - -## Properties - -### constant - -• **constant**: *boolean* - -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L94)* - -___ - -### inputs - -• **inputs**: *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L92)* - -___ - -### name - -• **name**: *string* - -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L91)* - -___ - -### outputs - -• **outputs**: *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L93)* - -___ - -### payable - -• **payable**: *boolean* - -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L96)* - -___ - -### stateMutability - -• **stateMutability**: *[StateMutability](#statemutability)* - -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L95)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L90)* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Class: InsufficientAssetLiquidityError Error class representing insufficient asset liquidity @@ -2490,7 +9,7 @@ Error class representing insufficient asset liquidity \+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* -*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/errors.ts#L12)* +*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/errors.ts#L12)* **Parameters:** @@ -2506,7 +25,7 @@ Name | Type | Description | • **amountAvailableToFill**: *`BigNumber`* -*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/errors.ts#L12)* +*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/errors.ts#L12)* The amount availabe to fill (in base units) factoring in slippage. @@ -2552,6 +71,2483 @@ ___
+# Class: SwapQuoteConsumer + + +## Implements + +* [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)‹*[SmartContractParams](#smartcontractparams)*› + + +## Constructors + + + +\+ **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/9fe6c196a/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L31)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`options` | `Partial` | {} | + +**Returns:** *[SwapQuoteConsumer](#class-swapquoteconsumer)* + +## Properties + +### networkId + +• **networkId**: *number* + +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L27)* + +___ + +### provider + +• **provider**: *`ZeroExProvider`* + +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L26)* + +## Methods + +### executeSwapQuoteOrThrowAsync + +▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* + +*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* + +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:81](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L81)* + +Given a SwapQuote and desired rate (in takerAsset), attempt to execute the swap. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`quote` | [SwapQuote](#swapquote) | - | An object that conforms to SwapQuote. See type definition for more information. | +`opts` | `Partial` | {} | Options for getting CalldataInfo. See type definition for more information. | + +**Returns:** *`Promise`* + +___ + +### getCalldataOrThrowAsync + +▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* + +*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* + +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`quote` | [SwapQuote](#swapquote) | - | An object that conforms to SwapQuote. See type definition for more information. | +`opts` | `Partial` | {} | Options for getting SmartContractParams. See type definition for more information. | + +**Returns:** *`Promise`* + +___ + +### getOptimalExtensionContractTypeAsync + +▸ **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/9fe6c196a/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L90)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`quote` | [SwapQuote](#swapquote) | - | +`opts` | `Partial` | {} | + +**Returns:** *`Promise`* + +___ + +### getSmartContractParamsOrThrowAsync + +▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* + +*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* + +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:67](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`quote` | [SwapQuote](#swapquote) | - | An object that conforms to SwapQuote. See type definition for more information. | +`opts` | `Partial` | {} | Options for getting SmartContractParams. See type definition for more information. | + +**Returns:** *`Promise>`* + +
+ +# Class: SwapQuoter + + +## Constructors + + + +\+ **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/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L126)* + +Instantiates a new SwapQuoter instance + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | +`orderbook` | `Orderbook` | - | An object that conforms to Orderbook, see type for definition. | +`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | + +**Returns:** *[SwapQuoter](#class-swapquoter)* + +An instance of SwapQuoter + +## Properties + +### expiryBufferMs + +• **expiryBufferMs**: *number* + +*Defined in [asset-swapper/src/swap_quoter.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L30)* + +___ + +### orderbook + +• **orderbook**: *`Orderbook`* + +*Defined in [asset-swapper/src/swap_quoter.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L29)* + +___ + +### provider + +• **provider**: *`ZeroExProvider`* + +*Defined in [asset-swapper/src/swap_quoter.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L28)* + +## Methods + +### destroyAsync + +▸ **destroyAsync**(): *`Promise`* + +*Defined in [asset-swapper/src/swap_quoter.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L391)* + +Destroys any subscriptions or connections. + +**Returns:** *`Promise`* + +___ + +### getAvailableMakerAssetDatasAsync + +▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* + +*Defined in [asset-swapper/src/swap_quoter.ts:309](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L309)* + +Get the asset data of all assets that are purchaseable with takerAssetData in the order provider passed in at init. + +**Parameters:** + +Name | Type | +------ | ------ | +`takerAssetData` | string | + +**Returns:** *`Promise`* + +An array of asset data strings that are purchaseable with takerAssetData. + +___ + +### getAvailableTakerAssetDatasAsync + +▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise`* + +*Defined in [asset-swapper/src/swap_quoter.ts:294](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L294)* + +Get the asset data of all assets that can be used to purchase makerAssetData in the order provider passed in at init. + +**Parameters:** + +Name | Type | +------ | ------ | +`makerAssetData` | string | + +**Returns:** *`Promise`* + +An array of asset data strings that can purchase makerAssetData. + +___ + +### getLiquidityForMakerTakerAssetDataPairAsync + +▸ **getLiquidityForMakerTakerAssetDataPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* + +*Defined in [asset-swapper/src/swap_quoter.ts:268](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L268)* + +Returns information about available liquidity for an asset +Does not factor in slippage or fees + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`makerAssetData` | string | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | +`takerAssetData` | string | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | + +**Returns:** *`Promise`* + +An object that conforms to LiquidityForAssetData that satisfies the request. See type definition for more information. + +___ + +### getMarketBuySwapQuoteAsync + +▸ **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/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L210)* + +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. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`makerTokenAddress` | string | - | The address of the maker asset | +`takerTokenAddress` | string | - | The address of the taker asset | +`makerAssetBuyAmount` | `BigNumber` | - | The amount of maker asset to swap for. | +`options` | `Partial` | {} | Options for the request. See type definition for more information. | + +**Returns:** *`Promise`* + +An object that conforms to SwapQuote that satisfies the request. See type definition for more information. + +___ + +### getMarketBuySwapQuoteForAssetDataAsync + +▸ **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/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L185)* + +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. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`makerAssetData` | string | - | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | +`takerAssetData` | string | - | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | +`makerAssetBuyAmount` | `BigNumber` | - | The amount of maker asset to swap for. | +`options` | `Partial` | {} | Options for the request. See type definition for more information. | + +**Returns:** *`Promise`* + +An object that conforms to SwapQuote that satisfies the request. See type definition for more information. + +___ + +### getMarketSellSwapQuoteAsync + +▸ **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/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L240)* + +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. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`makerTokenAddress` | string | - | The address of the maker asset | +`takerTokenAddress` | string | - | The address of the taker asset | +`takerAssetSellAmount` | `BigNumber` | - | The amount of taker asset to sell. | +`options` | `Partial` | {} | Options for the request. See type definition for more information. | + +**Returns:** *`Promise`* + +An object that conforms to SwapQuote that satisfies the request. See type definition for more information. + +___ + +### getMarketSellSwapQuoteForAssetDataAsync + +▸ **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/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L159)* + +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. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`makerAssetData` | string | - | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | +`takerAssetData` | string | - | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | +`takerAssetSellAmount` | `BigNumber` | - | The amount of taker asset to swap for. | +`options` | `Partial` | {} | Options for the request. See type definition for more information. | + +**Returns:** *`Promise`* + +An object that conforms to SwapQuote that satisfies the request. See type definition for more information. + +___ + +### getOrdersAndFillableAmountsAsync + +▸ **getOrdersAndFillableAmountsAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* + +*Defined in [asset-swapper/src/swap_quoter.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L341)* + +Grab orders from the map, if there is a miss or it is time to refresh, fetch and process the orders + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`makerAssetData` | string | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | +`takerAssetData` | string | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). | + +**Returns:** *`Promise`* + +___ + +### isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync + +▸ **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/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L372)* + +Util function to check if takerAddress's allowance is enough for 0x exchange contracts to conduct the swap specified by the swapQuote. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`swapQuote` | [SwapQuote](#swapquote) | The swapQuote in question to check enough allowance enabled for 0x exchange contracts to conduct the swap. | +`takerAddress` | string | The address of the taker of the provided swapQuote | + +**Returns:** *`Promise<[boolean, boolean]>`* + +___ + +### isTakerMakerAssetDataPairAvailableAsync + +▸ **isTakerMakerAssetDataPairAvailableAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* + +*Defined in [asset-swapper/src/swap_quoter.ts:324](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L324)* + +Validates the taker + maker asset pair is available from the order provider provided to `SwapQuote`. + +**Parameters:** + +Name | Type | +------ | ------ | +`makerAssetData` | string | +`takerAssetData` | string | + +**Returns:** *`Promise`* + +A boolean on if the taker, maker pair exists + +___ + +### `Static` getSwapQuoterForMeshEndpoint + +▸ **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/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L113)* + +Instantiates a new SwapQuoter instance given a 0x Mesh endpoint. This pulls all available liquidity stored in Mesh + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | +`meshEndpoint` | string | - | The standard relayer API base HTTP url you would like to source orders from. | +`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | + +**Returns:** *[SwapQuoter](#class-swapquoter)* + +An instance of SwapQuoter + +___ + +### `Static` getSwapQuoterForProvidedOrders + +▸ **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/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L41)* + +Instantiates a new SwapQuoter instance given existing liquidity in the form of orders and feeOrders. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | +`orders` | `SignedOrder`[] | - | A non-empty array of objects that conform to SignedOrder. All orders must have the same makerAssetData and takerAssetData. | +`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | + +**Returns:** *[SwapQuoter](#class-swapquoter)* + +An instance of SwapQuoter + +___ + +### `Static` getSwapQuoterForStandardRelayerAPIUrl + +▸ **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/9fe6c196a/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 + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | +`sraApiUrl` | string | - | The standard relayer API base HTTP url you would like to source orders from. | +`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | + +**Returns:** *[SwapQuoter](#class-swapquoter)* + +An instance of SwapQuoter + +___ + +### `Static` getSwapQuoterForStandardRelayerAPIWebsocket + +▸ **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/9fe6c196a/packages/asset-swapper/src/swap_quoter.ts#L88)* + +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. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. | +`sraApiUrl` | string | - | The standard relayer API base HTTP url you would like to source orders from. | +`sraWebsocketAPIUrl` | string | - | - | +`options` | `Partial` | {} | Initialization options for the SwapQuoter. See type definition for details. | + +**Returns:** *[SwapQuoter](#class-swapquoter)* + +An instance of SwapQuoter + +
+ +# Class: BaseOrderProvider + + +## Constructors + + + +\+ **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/9fe6c196a/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orderStore` | [OrderStore](#class-orderstore) | + +**Returns:** *[BaseOrderProvider](#class-baseorderprovider)* + +## Properties + +### _orderStore + +• **_orderStore**: *[OrderStore](#class-orderstore)* + +*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* + +## Methods + +### `Abstract` addOrdersAsync + +▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* + +*Defined in [orderbook/src/order_provider/base_order_provider.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_provider/base_order_provider.ts#L27)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `SignedOrder`[] | + +**Returns:** *`Promise`* + +___ + +### `Abstract` createSubscriptionForAssetPairAsync + +▸ **createSubscriptionForAssetPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* + +*Defined in [orderbook/src/order_provider/base_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_provider/base_order_provider.ts#L18)* + +**Parameters:** + +Name | Type | +------ | ------ | +`makerAssetData` | string | +`takerAssetData` | string | + +**Returns:** *`Promise`* + +___ + +### `Abstract` destroyAsync + +▸ **destroyAsync**(): *`Promise`* + +*Defined in [orderbook/src/order_provider/base_order_provider.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_provider/base_order_provider.ts#L25)* + +**Returns:** *`Promise`* + +___ + +### `Abstract` getAvailableAssetDatasAsync + +▸ **getAvailableAssetDatasAsync**(): *`Promise`* + +*Defined in [orderbook/src/order_provider/base_order_provider.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_provider/base_order_provider.ts#L23)* + +**Returns:** *`Promise`* + +
+ +# Class: OrderSet + + +## Constructors + + + +\+ **new OrderSet**(`orders`: `APIOrder`[]): *[OrderSet](#class-orderset)* + +*Defined in [orderbook/src/order_set.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_set.ts#L6)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`orders` | `APIOrder`[] | [] | + +**Returns:** *[OrderSet](#class-orderset)* + +## Methods + +### add + +▸ **add**(`item`: `APIOrder`): *void* + +*Defined in [orderbook/src/order_set.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_set.ts#L19)* + +**Parameters:** + +Name | Type | +------ | ------ | +`item` | `APIOrder` | + +**Returns:** *void* + +___ + +### addMany + +▸ **addMany**(`items`: `APIOrder`[]): *void* + +*Defined in [orderbook/src/order_set.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_set.ts#L25)* + +**Parameters:** + +Name | Type | +------ | ------ | +`items` | `APIOrder`[] | + +**Returns:** *void* + +___ + +### delete + +▸ **delete**(`item`: `APIOrder`): *boolean* + +*Defined in [orderbook/src/order_set.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_set.ts#L57)* + +**Parameters:** + +Name | Type | +------ | ------ | +`item` | `APIOrder` | + +**Returns:** *boolean* + +___ + +### deleteMany + +▸ **deleteMany**(`items`: `APIOrder`[]): *void* + +*Defined in [orderbook/src/order_set.ts:61](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_set.ts#L61)* + +**Parameters:** + +Name | Type | +------ | ------ | +`items` | `APIOrder`[] | + +**Returns:** *void* + +___ + +### diff + +▸ **diff**(`other`: [OrderSet](#class-orderset)): *object* + +*Defined in [orderbook/src/order_set.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_set.ts#L35)* + +**Parameters:** + +Name | Type | +------ | ------ | +`other` | [OrderSet](#class-orderset) | + +**Returns:** *object* + +___ + +### has + +▸ **has**(`order`: `APIOrder`): *boolean* + +*Defined in [orderbook/src/order_set.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_set.ts#L31)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | `APIOrder` | + +**Returns:** *boolean* + +___ + +### size + +▸ **size**(): *number* + +*Defined in [orderbook/src/order_set.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_set.ts#L15)* + +**Returns:** *number* + +___ + +### values + +▸ **values**(): *`IterableIterator`* + +*Defined in [orderbook/src/order_set.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_set.ts#L53)* + +**Returns:** *`IterableIterator`* + +
+ +# Class: OrderStore + + +## Methods + +### getOrderSetForAssetPair + +▸ **getOrderSetForAssetPair**(`assetPairKey`: string): *[OrderSet](#class-orderset)* + +*Defined in [orderbook/src/order_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_store.ts#L19)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetPairKey` | string | + +**Returns:** *[OrderSet](#class-orderset)* + +___ + +### getOrderSetForAssets + +▸ **getOrderSetForAssets**(`makerAssetData`: string, `takerAssetData`: string): *[OrderSet](#class-orderset)* + +*Defined in [orderbook/src/order_store.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_store.ts#L15)* + +**Parameters:** + +Name | Type | +------ | ------ | +`makerAssetData` | string | +`takerAssetData` | string | + +**Returns:** *[OrderSet](#class-orderset)* + +___ + +### has + +▸ **has**(`assetPairKey`: string): *boolean* + +*Defined in [orderbook/src/order_store.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_store.ts#L34)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetPairKey` | string | + +**Returns:** *boolean* + +___ + +### keys + +▸ **keys**(): *`IterableIterator`* + +*Defined in [orderbook/src/order_store.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_store.ts#L40)* + +**Returns:** *`IterableIterator`* + +___ + +### update + +▸ **update**(`addedRemoved`: [AddedRemovedOrders](#interface-addedremovedorders)): *void* + +*Defined in [orderbook/src/order_store.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_store.ts#L28)* + +**Parameters:** + +Name | Type | +------ | ------ | +`addedRemoved` | [AddedRemovedOrders](#interface-addedremovedorders) | + +**Returns:** *void* + +___ + +### values + +▸ **values**(`assetPairKey`: string): *`APIOrder`[]* + +*Defined in [orderbook/src/order_store.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_store.ts#L37)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetPairKey` | string | + +**Returns:** *`APIOrder`[]* + +___ + +### `Static` assetPairKeyToAssets + +▸ **assetPairKeyToAssets**(`assetPairKey`: string): *string[]* + +*Defined in [orderbook/src/order_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_store.ts#L12)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetPairKey` | string | + +**Returns:** *string[]* + +___ + +### `Static` getKeyForAssetPair + +▸ **getKeyForAssetPair**(`makerAssetData`: string, `takerAssetData`: string): *string* + +*Defined in [orderbook/src/order_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/order_store.ts#L9)* + +**Parameters:** + +Name | Type | +------ | ------ | +`makerAssetData` | string | +`takerAssetData` | string | + +**Returns:** *string* + +
+ +# Class: Orderbook + + +## Constructors + + + +\+ **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/9fe6c196a/packages/orderbook/src/orderbook.ts#L55)* + +Creates an Orderbook with the order provider. All order updates are stored +in the `OrderStore`. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orderProvider` | [BaseOrderProvider](#class-baseorderprovider) | the order provider, e.g SRAWebbsocketOrderProvider | +`orderStore` | [OrderStore](#class-orderstore) | the order store where orders are added and deleted | + +**Returns:** *[Orderbook](#class-orderbook)* + +## Methods + +### addOrdersAsync + +▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* + +*Defined in [orderbook/src/orderbook.ts:98](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `SignedOrder`[] | The set of Orders to add to the Order Provider | + +**Returns:** *`Promise`* + +___ + +### destroyAsync + +▸ **destroyAsync**(): *`Promise`* + +*Defined in [orderbook/src/orderbook.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/orderbook.ts#L104)* + +Destroys any subscriptions or connections. + +**Returns:** *`Promise`* + +___ + +### getAvailableAssetDatasAsync + +▸ **getAvailableAssetDatasAsync**(): *`Promise`* + +*Defined in [orderbook/src/orderbook.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/orderbook.ts#L90)* + +Returns all of the Available Asset Pairs for the provided Order Provider. + +**Returns:** *`Promise`* + +___ + +### getOrdersAsync + +▸ **getOrdersAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* + +*Defined in [orderbook/src/orderbook.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/orderbook.ts#L75)* + +Returns all orders where the order.makerAssetData == makerAssetData and +order.takerAssetData == takerAssetData. This pair is then subscribed to +and all future updates will be stored. The first request +to `getOrdersAsync` might fetch the orders from the Order Provider and create a subscription. +Subsequent requests will be quick and up to date and synced with the Order Provider state. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`makerAssetData` | string | the maker asset data | +`takerAssetData` | string | the taker asset data | + +**Returns:** *`Promise`* + +___ + +### `Static` getOrderbookForMeshProvider + +▸ **getOrderbookForMeshProvider**(`opts`: [MeshOrderProviderOpts](#interface-meshorderprovideropts)): *[Orderbook](#class-orderbook)* + +*Defined in [orderbook/src/orderbook.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [MeshOrderProviderOpts](#interface-meshorderprovideropts) | the `MeshOrderProviderOpts` | + +**Returns:** *[Orderbook](#class-orderbook)* + +___ + +### `Static` getOrderbookForPollingProvider + +▸ **getOrderbookForPollingProvider**(`opts`: [SRAPollingOrderProviderOpts](#interface-srapollingorderprovideropts)): *[Orderbook](#class-orderbook)* + +*Defined in [orderbook/src/orderbook.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/orderbook.ts#L43)* + +Creates an Orderbook with SRA Polling Provider. This Provider simply polls every interval. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [SRAPollingOrderProviderOpts](#interface-srapollingorderprovideropts) | the `SRAPollingOrderProviderOpts` | + +**Returns:** *[Orderbook](#class-orderbook)* + +___ + +### `Static` getOrderbookForProvidedOrders + +▸ **getOrderbookForProvidedOrders**(`orders`: `SignedOrder`[]): *[Orderbook](#class-orderbook)* + +*Defined in [orderbook/src/orderbook.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `SignedOrder`[] | the set of SignedOrders | + +**Returns:** *[Orderbook](#class-orderbook)* + +___ + +### `Static` getOrderbookForWebsocketProvider + +▸ **getOrderbookForWebsocketProvider**(`opts`: [SRAWebsocketOrderProviderOpts](#interface-srawebsocketorderprovideropts)): *[Orderbook](#class-orderbook)* + +*Defined in [orderbook/src/orderbook.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [SRAWebsocketOrderProviderOpts](#interface-srawebsocketorderprovideropts) | the `SRAWebsocketOrderProviderOpts` | + +**Returns:** *[Orderbook](#class-orderbook)* + +
+ +# Enumeration: ExtensionContractType + +Represents the varying smart contracts that can consume a valid swap quote + + +## Enumeration members + +### Forwarder + +• **Forwarder**: = "FORWARDER" + +*Defined in [asset-swapper/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L90)* + +___ + +### None + +• **None**: = "NONE" + +*Defined in [asset-swapper/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L91)* + +
+ + + +# Enumeration: SwapQuoterError + +Possible error messages thrown by an SwapQuoter instance or associated static methods. + + +## Enumeration members + +### AssetUnavailable + +• **AssetUnavailable**: = "ASSET_UNAVAILABLE" + +*Defined in [asset-swapper/src/types.ts:305](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L305)* + +___ + +### FeeAssetUnavailable + +• **FeeAssetUnavailable**: = "FEE_ASSET_UNAVAILABLE" + +*Defined in [asset-swapper/src/types.ts:306](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L306)* + +___ + +### InsufficientAssetLiquidity + +• **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" + +*Defined in [asset-swapper/src/types.ts:302](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L302)* + +___ + +### InsufficientZrxLiquidity + +• **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY" + +*Defined in [asset-swapper/src/types.ts:303](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L303)* + +___ + +### InvalidOrderProviderResponse + +• **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE" + +*Defined in [asset-swapper/src/types.ts:304](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L304)* + +___ + +### NoEtherTokenContractFound + +• **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND" + +*Defined in [asset-swapper/src/types.ts:299](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L299)* + +___ + +### NoZrxTokenContractFound + +• **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND" + +*Defined in [asset-swapper/src/types.ts:300](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L300)* + +___ + +### StandardRelayerApiError + +• **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR" + +*Defined in [asset-swapper/src/types.ts:301](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L301)* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Interface: CalldataInfo + +Represents the metadata to call a smart contract with calldata. +calldataHexString: The hexstring of the calldata. +methodAbi: The ABI of the smart contract method to call. +toAddress: The contract address to call. +ethAmount: If provided, the eth amount in wei to send with the smart contract call. + + +## Properties + +### calldataHexString + +• **calldataHexString**: *string* + +*Defined in [asset-swapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L39)* + +___ + +### `Optional` ethAmount + +• **ethAmount**? : *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L42)* + +___ + +### methodAbi + +• **methodAbi**: *`MethodAbi`* + +*Defined in [asset-swapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L40)* + +___ + +### toAddress + +• **toAddress**: *string* + +*Defined in [asset-swapper/src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L41)* + +
+ + + + + + + + + + + +# Interface: ForwarderSwapQuoteExecutionOpts + + +## Properties + +### `Optional` ethAmount + +• **ethAmount**? : *`BigNumber`* + +*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)* + +*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L181)* + +___ + +### feePercentage + +• **feePercentage**: *number* + +*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)* + +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L179)* + +___ + +### feeRecipient + +• **feeRecipient**: *string* + +*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)* + +*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L180)* + +___ + +### `Optional` gasLimit + +• **gasLimit**? : *undefined | number* + +*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasLimit](#optional-gaslimit)* + +*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L169)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *`BigNumber`* + +*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasPrice](#optional-gasprice)* + +*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L170)* + +___ + +### `Optional` takerAddress + +• **takerAddress**? : *undefined | string* + +*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[takerAddress](#optional-takeraddress)* + +*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L168)* + +
+ +# Interface: ForwarderSwapQuoteGetOutputOpts + +feePercentage: percentage (up to 5%) of the taker asset paid to feeRecipient +feeRecipient: address of the receiver of the feePercentage of taker asset +ethAmount: The amount of eth (in Wei) sent to the forwarder contract. + + +## Properties + +### `Optional` ethAmount + +• **ethAmount**? : *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L181)* + +___ + +### feePercentage + +• **feePercentage**: *number* + +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L179)* + +___ + +### feeRecipient + +• **feeRecipient**: *string* + +*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L180)* + +
+ +# Interface: GetExtensionContractTypeOpts + + +## Properties + +### `Optional` ethAmount + +• **ethAmount**? : *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:188](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L188)* + +___ + +### `Optional` takerAddress + +• **takerAddress**? : *undefined | string* + +*Defined in [asset-swapper/src/types.ts:187](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L187)* + +
+ +# Interface: LiquidityForAssetData + +Represents available liquidity for a given assetData + + +## Properties + +### makerTokensAvailableInBaseUnits + +• **makerTokensAvailableInBaseUnits**: *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:322](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L322)* + +___ + +### takerTokensAvailableInBaseUnits + +• **takerTokensAvailableInBaseUnits**: *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:323](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L323)* + +
+ +# Interface: MarketBuySwapQuote + +makerAssetFillAmount: The amount of makerAsset bought with takerAsset. +type: Specified MarketOperation the SwapQuote is provided for + + +## Properties + +### bestCaseQuoteInfo + +• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* + +*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L219)* + +___ + +### feeOrders + +• **feeOrders**: *`SignedOrder`[]* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* + +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L218)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* + +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L216)* + +___ + +### makerAssetFillAmount + +• **makerAssetFillAmount**: *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:237](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L237)* + +___ + +### orders + +• **orders**: *`SignedOrder`[]* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* + +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L217)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* + +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L215)* + +___ + +### type + +• **type**: *`Buy`* + +*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L238)* + +___ + +### worstCaseQuoteInfo + +• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* + +*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L220)* + +
+ +# Interface: MarketBuySwapQuoteWithAffiliateFee + + +## Properties + +### bestCaseQuoteInfo + +• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* + +*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L219)* + +___ + +### feeOrders + +• **feeOrders**: *`SignedOrder`[]* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* + +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L218)* + +___ + +### feePercentage + +• **feePercentage**: *number* + +*Inherited from [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase).[feePercentage](#feepercentage)* + +*Defined in [asset-swapper/src/types.ts:242](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L242)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* + +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L216)* + +___ + +### makerAssetFillAmount + +• **makerAssetFillAmount**: *`BigNumber`* + +*Inherited from [MarketBuySwapQuote](#interface-marketbuyswapquote).[makerAssetFillAmount](#makerassetfillamount)* + +*Defined in [asset-swapper/src/types.ts:237](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L237)* + +___ + +### orders + +• **orders**: *`SignedOrder`[]* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* + +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L217)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* + +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L215)* + +___ + +### type + +• **type**: *`Buy`* + +*Inherited from [MarketBuySwapQuote](#interface-marketbuyswapquote).[type](#type)* + +*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L238)* + +___ + +### worstCaseQuoteInfo + +• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* + +*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L220)* + +
+ +# Interface: MarketSellSwapQuote + +takerAssetFillAmount: The amount of takerAsset sold for makerAsset. +type: Specified MarketOperation the SwapQuote is provided for + + +## Properties + +### bestCaseQuoteInfo + +• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* + +*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L219)* + +___ + +### feeOrders + +• **feeOrders**: *`SignedOrder`[]* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* + +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L218)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* + +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L216)* + +___ + +### orders + +• **orders**: *`SignedOrder`[]* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* + +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L217)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* + +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L215)* + +___ + +### takerAssetFillAmount + +• **takerAssetFillAmount**: *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:228](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L228)* + +___ + +### type + +• **type**: *`Sell`* + +*Defined in [asset-swapper/src/types.ts:229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L229)* + +___ + +### worstCaseQuoteInfo + +• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* + +*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L220)* + +
+ +# Interface: MarketSellSwapQuoteWithAffiliateFee + + +## Properties + +### bestCaseQuoteInfo + +• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* + +*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L219)* + +___ + +### feeOrders + +• **feeOrders**: *`SignedOrder`[]* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* + +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L218)* + +___ + +### feePercentage + +• **feePercentage**: *number* + +*Inherited from [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase).[feePercentage](#feepercentage)* + +*Defined in [asset-swapper/src/types.ts:242](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L242)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* + +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L216)* + +___ + +### orders + +• **orders**: *`SignedOrder`[]* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* + +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L217)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* + +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L215)* + +___ + +### takerAssetFillAmount + +• **takerAssetFillAmount**: *`BigNumber`* + +*Inherited from [MarketSellSwapQuote](#interface-marketsellswapquote).[takerAssetFillAmount](#takerassetfillamount)* + +*Defined in [asset-swapper/src/types.ts:228](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L228)* + +___ + +### type + +• **type**: *`Sell`* + +*Inherited from [MarketSellSwapQuote](#interface-marketsellswapquote).[type](#type)* + +*Defined in [asset-swapper/src/types.ts:229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L229)* + +___ + +### worstCaseQuoteInfo + +• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)* + +*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* + +*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L220)* + +
+ + + + + + + + + + + +# Interface: SmartContractParamsInfo <**T**> + +Represents the metadata to call a smart contract with parameters. +params: The metadata object containing all the input parameters of a smart contract call. +toAddress: The contract address to call. +ethAmount: If provided, the eth amount in wei to send with the smart contract call. +methodAbi: The ABI of the smart contract method to call with params. + +## Type parameters + +▪ **T** + + +## Properties + +### `Optional` ethAmount + +• **ethAmount**? : *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L55)* + +___ + +### methodAbi + +• **methodAbi**: *`MethodAbi`* + +*Defined in [asset-swapper/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L56)* + +___ + +### params + +• **params**: *`T`* + +*Defined in [asset-swapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L53)* + +___ + +### toAddress + +• **toAddress**: *string* + +*Defined in [asset-swapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L54)* + +
+ + + +# Interface: SwapQuoteConsumerBase <**T**> + +Interface that varying SwapQuoteConsumers adhere to (exchange consumer, router consumer, forwarder consumer, coordinator consumer) +getCalldataOrThrow: Get CalldataInfo to swap for tokens with provided SwapQuote. Throws if invalid SwapQuote is provided. +getSmartContractParamsOrThrow: Get SmartContractParamsInfo to swap for tokens with provided SwapQuote. Throws if invalid SwapQuote is provided. +executeSwapQuoteOrThrowAsync: Executes a web3 transaction to swap for tokens with provided SwapQuote. Throws if invalid SwapQuote is provided. + +## Type parameters + +▪ **T** + + +## Implemented by + +* [SwapQuoteConsumer](#class-swapquoteconsumer) + + +## Methods + +### executeSwapQuoteOrThrowAsync + +▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* + +*Defined in [asset-swapper/src/types.ts:147](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L147)* + +**Parameters:** + +Name | Type | +------ | ------ | +`quote` | [SwapQuote](#swapquote) | +`opts` | `Partial` | + +**Returns:** *`Promise`* + +___ + +### getCalldataOrThrowAsync + +▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* + +*Defined in [asset-swapper/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L142)* + +**Parameters:** + +Name | Type | +------ | ------ | +`quote` | [SwapQuote](#swapquote) | +`opts` | `Partial` | + +**Returns:** *`Promise`* + +___ + +### getSmartContractParamsOrThrowAsync + +▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* + +*Defined in [asset-swapper/src/types.ts:143](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L143)* + +**Parameters:** + +Name | Type | +------ | ------ | +`quote` | [SwapQuote](#swapquote) | +`opts` | `Partial` | + +**Returns:** *`Promise>`* + +
+ +# Interface: SwapQuoteConsumerOpts + +networkId: The networkId that the desired orders should be for. + + +## Properties + +### networkId + +• **networkId**: *number* + +*Defined in [asset-swapper/src/types.ts:154](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L154)* + +
+ +# Interface: SwapQuoteExecutionOpts + +Represents the options for executing a swap quote with SwapQuoteConsumer + + +## Properties + +### `Optional` ethAmount + +• **ethAmount**? : *`BigNumber`* + +*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)* + +*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/9fe6c196a/packages/asset-swapper/src/types.ts#L181)* + +___ + +### feePercentage + +• **feePercentage**: *number* + +*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)* + +*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/9fe6c196a/packages/asset-swapper/src/types.ts#L179)* + +___ + +### feeRecipient + +• **feeRecipient**: *string* + +*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)* + +*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/9fe6c196a/packages/asset-swapper/src/types.ts#L180)* + +___ + +### `Optional` gasLimit + +• **gasLimit**? : *undefined | number* + +*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasLimit](#optional-gaslimit)* + +*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L169)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *`BigNumber`* + +*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasPrice](#optional-gasprice)* + +*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L170)* + +___ + +### `Optional` takerAddress + +• **takerAddress**? : *undefined | string* + +*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[takerAddress](#optional-takeraddress)* + +*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L168)* + +___ + +### useExtensionContract + +• **useExtensionContract**: *[ExtensionContractType](#enumeration-extensioncontracttype)* + +*Inherited from [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts).[useExtensionContract](#useextensioncontract)* + +*Defined in [asset-swapper/src/types.ts:196](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L196)* + +
+ +# Interface: SwapQuoteExecutionOptsBase + +takerAddress: The address to perform the buy. Defaults to the first available address from the provider. +gasLimit: The amount of gas to send with a transaction (in Gwei). Defaults to an eth_estimateGas rpc call. +gasPrice: Gas price in Wei to use for a transaction + + +## Properties + +### `Optional` gasLimit + +• **gasLimit**? : *undefined | number* + +*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L169)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L170)* + +___ + +### `Optional` takerAddress + +• **takerAddress**? : *undefined | string* + +*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L168)* + +
+ +# Interface: SwapQuoteGetOutputOpts + +takerAddress: The address to perform the buy. Defaults to the first available address from the provider. +useConsumerType: If provided, defaults the SwapQuoteConsumer to create output consumed by ConsumerType. + + +## Properties + +### `Optional` ethAmount + +• **ethAmount**? : *`BigNumber`* + +*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)* + +*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L181)* + +___ + +### feePercentage + +• **feePercentage**: *number* + +*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)* + +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L179)* + +___ + +### feeRecipient + +• **feeRecipient**: *string* + +*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)* + +*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L180)* + +___ + +### useExtensionContract + +• **useExtensionContract**: *[ExtensionContractType](#enumeration-extensioncontracttype)* + +*Defined in [asset-swapper/src/types.ts:196](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L196)* + +
+ +# Interface: SwapQuoteGetOutputOptsBase + +Represents the options provided to a generic SwapQuoteConsumer + + +## Hierarchy + +* **SwapQuoteInfo** + + +## Properties + +### feeTakerTokenAmount + +• **feeTakerTokenAmount**: *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:258](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L258)* + +___ + +### makerTokenAmount + +• **makerTokenAmount**: *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:261](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L261)* + +___ + +### takerTokenAmount + +• **takerTokenAmount**: *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:260](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L260)* + +___ + +### totalTakerTokenAmount + +• **totalTakerTokenAmount**: *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:259](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L259)* + +
+ +# Interface: SwapQuoteRequestOpts + +shouldDisableRequestingFeeOrders: If set to true, requesting a swapQuote will not perform any computation or requests for fees. +slippagePercentage: The percentage buffer to add to account for slippage. Affects max ETH price estimates. Defaults to 0.2 (20%). + + +## Properties + +### shouldDisableRequestingFeeOrders + +• **shouldDisableRequestingFeeOrders**: *boolean* + +*Defined in [asset-swapper/src/types.ts:269](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L269)* + +___ + +### slippagePercentage + +• **slippagePercentage**: *number* + +*Defined in [asset-swapper/src/types.ts:270](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L270)* + +
+ +# Interface: SwapQuoterOpts + +networkId: The ethereum network id. Defaults to 1 (mainnet). +orderRefreshIntervalMs: The interval in ms that getBuyQuoteAsync should trigger an refresh of orders and order states. Defaults to 10000ms (10s). +expiryBufferMs: The number of seconds to add when calculating whether an order is expired or not. Defaults to 300s (5m). + + +## Properties + +### expiryBufferMs + +• **expiryBufferMs**: *number* + +*Defined in [asset-swapper/src/types.ts:281](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L281)* + +___ + +### networkId + +• **networkId**: *number* + +*Defined in [asset-swapper/src/types.ts:279](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L279)* + +___ + +### orderRefreshIntervalMs + +• **orderRefreshIntervalMs**: *number* + +*Defined in [asset-swapper/src/types.ts:280](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L280)* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Interface: DataItem + + +## Properties + +### `Optional` components + +• **components**? : *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* + +___ + +### name + +• **name**: *string* + +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)* + +
+ + + + + + + +# Interface: EIP1193Provider + + +## Properties + +### isEIP1193 + +• **isEIP1193**: *boolean* + +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* + +## Methods + +### on + +▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* + +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* + +**Parameters:** + +▪ **event**: *[EIP1193Event](#eip1193event)* + +▪ **listener**: *function* + +▸ (`result`: any): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`result` | any | + +**Returns:** *this* + +___ + +### send + +▸ **send**(`method`: string, `params?`: any[]): *`Promise`* + +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* + +**Parameters:** + +Name | Type | +------ | ------ | +`method` | string | +`params?` | any[] | + +**Returns:** *`Promise`* + +
+ + + + + + + + + + + + + +# 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/9fe6c196a/packages/ethereum-types/src/index.ts#L14)* + +**Parameters:** + +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | + +**Returns:** *void* + +
+ + + +# Interface: JSONRPCRequestPayload + + +## Properties + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* + +___ + +### method + +• **method**: *string* + +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* + +___ + +### params + +• **params**: *any[]* + +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)* + +
+ +# Interface: JSONRPCResponseError + + +## Properties + +### code + +• **code**: *number* + +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* + +___ + +### message + +• **message**: *string* + +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)* + +
+ +# Interface: JSONRPCResponsePayload + + +## Properties + +### `Optional` error + +• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* + +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* + +___ + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* + +___ + +### result + +• **result**: *any* + +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)* + +
+ + + + + + + +# Interface: MethodAbi + + +## Properties + +### constant + +• **constant**: *boolean* + +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L94)* + +___ + +### inputs + +• **inputs**: *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L92)* + +___ + +### name + +• **name**: *string* + +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L91)* + +___ + +### outputs + +• **outputs**: *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L93)* + +___ + +### payable + +• **payable**: *boolean* + +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L96)* + +___ + +### stateMutability + +• **stateMutability**: *[StateMutability](#statemutability)* + +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L95)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L90)* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Interface: TupleDataItem + + +## Properties + +### components + +• **components**: *[DataItem](#class-dataitem)[]* + +*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* + +*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L141)* + +___ + +### name + +• **name**: *string* + +*Inherited from [DataItem](#interface-dataitem).[name](#name)* + +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* + +___ + +### type + +• **type**: *string* + +*Inherited from [DataItem](#interface-dataitem).[type](#type)* + +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)* + +
+ @@ -2569,7 +2565,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/44793a9cf/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -2585,7 +2581,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/44793a9cf/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -2611,7 +2607,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/44793a9cf/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -2637,7 +2633,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/44793a9cf/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -2663,7 +2659,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ @@ -2671,7 +2667,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ @@ -2679,7 +2675,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -2687,7 +2683,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -2697,7 +2693,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/44793a9cf/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -2714,7 +2710,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -2729,7 +2725,7 @@ ___ • **accepted**: *`SignedOrder`[]* -*Defined in [orderbook/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L15)* +*Defined in [orderbook/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L15)* ___ @@ -2737,7 +2733,7 @@ ___ • **rejected**: *[RejectedOrder](#class-rejectedorder)[]* -*Defined in [orderbook/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L16)* +*Defined in [orderbook/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L16)*
@@ -2750,7 +2746,7 @@ ___ • **added**: *`APIOrder`[]* -*Defined in [orderbook/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L6)* +*Defined in [orderbook/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L6)* ___ @@ -2758,7 +2754,7 @@ ___ • **assetPairKey**: *string* -*Defined in [orderbook/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L5)* +*Defined in [orderbook/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L5)* ___ @@ -2766,7 +2762,7 @@ ___ • **removed**: *`APIOrder`[]* -*Defined in [orderbook/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L7)* +*Defined in [orderbook/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L7)*
@@ -2781,7 +2777,7 @@ Constructor options for a Mesh Order Provider • **websocketEndpoint**: *string* -*Defined in [orderbook/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L52)* +*Defined in [orderbook/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L52)* ___ @@ -2789,7 +2785,7 @@ ___ • **wsOpts**? : *`WSOpts`* -*Defined in [orderbook/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L54)* +*Defined in [orderbook/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L54)*
@@ -2802,7 +2798,7 @@ ___ • **message**: *string* -*Defined in [orderbook/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L11)* +*Defined in [orderbook/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L11)* ___ @@ -2810,7 +2806,7 @@ ___ • **order**: *`SignedOrder`* -*Defined in [orderbook/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L12)* +*Defined in [orderbook/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L12)*
@@ -2825,7 +2821,7 @@ Constructor options for a SRA Polling Order Provider • **httpEndpoint**: *string* -*Defined in [orderbook/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L38)* +*Defined in [orderbook/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L38)* ___ @@ -2833,7 +2829,7 @@ ___ • **networkId**? : *undefined | number* -*Defined in [orderbook/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L44)* +*Defined in [orderbook/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L44)* ___ @@ -2841,7 +2837,7 @@ ___ • **perPage**? : *undefined | number* -*Defined in [orderbook/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L42)* +*Defined in [orderbook/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L42)* ___ @@ -2849,7 +2845,7 @@ ___ • **pollingIntervalMs**: *number* -*Defined in [orderbook/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L40)* +*Defined in [orderbook/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L40)*
@@ -2864,7 +2860,7 @@ Constructor options for a SRA Websocket Order Provider • **httpEndpoint**: *string* -*Defined in [orderbook/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L26)* +*Defined in [orderbook/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L26)* ___ @@ -2872,7 +2868,7 @@ ___ • **networkId**? : *undefined | number* -*Defined in [orderbook/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L30)* +*Defined in [orderbook/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L30)* ___ @@ -2880,7 +2876,7 @@ ___ • **websocketEndpoint**: *string* -*Defined in [orderbook/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/orderbook/src/types.ts#L28)* +*Defined in [orderbook/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/orderbook/src/types.ts#L28)*
@@ -2893,7 +2889,7 @@ ___ • **metaData**: *object* -*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L408)* +*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L408)* ___ @@ -2901,7 +2897,7 @@ ___ • **order**: *[SignedOrder](#class-signedorder)* -*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L407)* +*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L407)*
@@ -2916,7 +2912,7 @@ ___ • **assetData**: *string* -*Defined in [types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L424)* +*Defined in [types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L424)* ___ @@ -2924,7 +2920,7 @@ ___ • **maxAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L426)* +*Defined in [types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L426)* ___ @@ -2932,7 +2928,7 @@ ___ • **minAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L425)* +*Defined in [types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L425)* ___ @@ -2940,7 +2936,7 @@ ___ • **precision**: *number* -*Defined in [types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L427)* +*Defined in [types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L427)*
@@ -2953,7 +2949,7 @@ ___ • **assetDataA**: *[Asset](#class-asset)* -*Defined in [types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L419)* +*Defined in [types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L419)* ___ @@ -2961,7 +2957,7 @@ ___ • **assetDataB**: *[Asset](#class-asset)* -*Defined in [types/src/index.ts:420](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L420)* +*Defined in [types/src/index.ts:420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L420)*
@@ -3007,8 +3003,6 @@ ___ - - @@ -3058,8 +3052,6 @@ ___ - - @@ -3074,7 +3066,7 @@ ___ *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* ___ @@ -3084,7 +3076,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -3094,7 +3086,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -3104,7 +3096,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -3114,7 +3106,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -3124,7 +3116,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -3134,7 +3126,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -3144,7 +3136,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* ___ @@ -3154,7 +3146,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -3164,7 +3156,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -3174,7 +3166,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -3182,7 +3174,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -3192,7 +3184,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -3202,7 +3194,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -3212,7 +3204,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -3222,7 +3214,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* ___ @@ -3232,7 +3224,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -3264,33 +3256,6 @@ ___ - - - - - - - - - - - - - - - - - - - - - -## Type aliases - - - - - @@ -3336,7 +3301,7 @@ ___ Ƭ **SwapQuote**: *[MarketBuySwapQuote](#interface-marketbuyswapquote) | [MarketSellSwapQuote](#interface-marketsellswapquote)* -*Defined in [asset-swapper/src/types.ts:184](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/asset-swapper/src/types.ts#L184)* +*Defined in [asset-swapper/src/types.ts:184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/asset-swapper/src/types.ts#L184)* ___ @@ -3355,7 +3320,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L84)* ___ @@ -3369,7 +3334,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -3386,7 +3351,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -3413,7 +3378,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L85)* ___ @@ -3421,7 +3386,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/44793a9cf/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -3436,7 +3401,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/44793a9cf/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)*
@@ -3449,7 +3414,7 @@ ___ • **DEFAULT_TOKEN_PRECISION**: *`18`* = 18 -*Defined in [orderbook/src/order_provider/base_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/packages/orderbook/src/order_provider/base_order_provider.ts#L9)*
@@ -3472,3 +3437,34 @@ ___ + + + +## Type aliases + + + + + + + + + + + + + + + + + + + + + + + + + +
+ diff --git a/packages/base-contract/CHANGELOG.json b/packages/base-contract/CHANGELOG.json index bdc985e363..c691b66589 100644 --- a/packages/base-contract/CHANGELOG.json +++ b/packages/base-contract/CHANGELOG.json @@ -10,8 +10,7 @@ "note": "Remove duplicate types `IndexedFilterValues`, `DecodedLogEvent`, `EventCallback`", "pr": 2243 } - ], - "timestamp": 1573001598 + ] }, { "version": "5.5.0-beta.0", diff --git a/packages/base-contract/CHANGELOG.md b/packages/base-contract/CHANGELOG.md index 3119c65ea7..4fcff1d41b 100644 --- a/packages/base-contract/CHANGELOG.md +++ b/packages/base-contract/CHANGELOG.md @@ -5,11 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v5.5.0-beta.1 - _November 6, 2019_ - - * Make `evmExecAsync` protected and rename to `_evmExecAsync` (#2243) - * Remove duplicate types `IndexedFilterValues`, `DecodedLogEvent`, `EventCallback` (#2243) - ## v5.5.0-beta.0 - _October 3, 2019_ * Automatically decode and throw rich reverts in `_throwIfRevertWithReasonCallResult` (#1761) diff --git a/packages/connect/CHANGELOG.json b/packages/connect/CHANGELOG.json index 4d86f193dd..02b53e52f5 100644 --- a/packages/connect/CHANGELOG.json +++ b/packages/connect/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "5.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "5.1.0-beta.0", "changes": [ diff --git a/packages/connect/CHANGELOG.md b/packages/connect/CHANGELOG.md index 8f5a78a2db..2a656265d7 100644 --- a/packages/connect/CHANGELOG.md +++ b/packages/connect/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v5.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v5.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/connect/docs/reference.mdx b/packages/connect/docs/reference.mdx index bfb1c456a0..5dba505116 100644 --- a/packages/connect/docs/reference.mdx +++ b/packages/connect/docs/reference.mdx @@ -1,73 +1,196 @@ +# 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/9fe6c196a/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/9fe6c196a/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 network id. | +**Returns:** *`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/44793a9cf/packages/types/src/index.ts#L416)* +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/9fe6c196a/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 network id. | -### FeeRecipientsResponse +**Returns:** *`Promise`* -Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›* - -*Defined in [types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L484)* +The resulting FeeRecipientsResponse ___ +### getOrderAsync +▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise`* +*Defined in [connect/src/http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L99)* +Retrieve a specific order from the API -### OrdersResponse +**Parameters:** -Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›* +Name | Type | Description | +------ | ------ | ------ | +`orderHash` | string | An orderHash generated from the desired order | +`requestOpts?` | [RequestOpts](#interface-requestopts) | - | -*Defined in [types/src/index.ts:404](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L404)* +**Returns:** *`Promise`* + +The APIOrder that matches the supplied orderHash ___ + +### getOrderConfigAsync + +▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise`* + +*Defined in [connect/src/http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 network id. | + +**Returns:** *`Promise`* + +The resulting OrderConfigResponse that matches the request + +___ + +### getOrderbookAsync + +▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise`* + +*Defined in [connect/src/http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 network id. | + +**Returns:** *`Promise`* + +The resulting OrderbookResponse that matches the request + +___ + +### getOrdersAsync + +▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise`* + +*Defined in [connect/src/http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L79)* + +Retrieve orders from the API + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`requestOpts?` | `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information, and network 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/9fe6c196a/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 network id. | + +**Returns:** *`Promise`* + +
+ + + + + + + + + + + + + + + + + + + + + + + + @@ -86,7 +209,7 @@ ___ • **metaData**: *object* -*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L408)* +*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L408)* ___ @@ -94,7 +217,7 @@ ___ • **order**: *[SignedOrder](#class-signedorder)* -*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L407)* +*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L407)*
@@ -146,8 +269,6 @@ ___ - - @@ -199,7 +320,7 @@ ___ • **page**? : *undefined | number* -*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L491)* +*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L491)* ___ @@ -207,7 +328,7 @@ ___ • **perPage**? : *undefined | number* -*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L492)* +*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L492)*
@@ -224,7 +345,7 @@ ___ • **page**: *number* -*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L459)* +*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L459)* ___ @@ -232,7 +353,7 @@ ___ • **perPage**: *number* -*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L460)* +*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L460)* ___ @@ -240,7 +361,7 @@ ___ • **records**: *`T`[]* -*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L461)* +*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L461)* ___ @@ -248,7 +369,7 @@ ___ • **total**: *number* -*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L458)* +*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L458)*
@@ -265,12 +386,10 @@ ___ • **networkId**? : *undefined | number* -*Defined in [types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L487)* +*Defined in [types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L487)*
- - # Interface: SignedOrder @@ -282,7 +401,7 @@ ___ *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* ___ @@ -292,7 +411,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -302,7 +421,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -312,7 +431,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -322,7 +441,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -332,7 +451,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -342,7 +461,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -352,7 +471,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* ___ @@ -362,7 +481,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -372,7 +491,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -382,7 +501,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -390,7 +509,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -400,7 +519,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -410,7 +529,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -420,7 +539,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -430,7 +549,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* ___ @@ -440,7 +559,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -491,10 +610,6 @@ ___ - -
- -
@@ -507,13 +622,13 @@ ___ #### ▪ **ordersChannelFactory**: *object* -*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/connect/src/orders_channel_factory.ts#L7)* +*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/connect/src/orders_channel_factory.ts#L15)* +*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/orders_channel_factory.ts#L15)* Instantiates a new WebSocketOrdersChannel instance @@ -530,3 +645,52 @@ 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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/packages/types/src/index.ts#L404)* + +___ + + + diff --git a/packages/contract-addresses/CHANGELOG.json b/packages/contract-addresses/CHANGELOG.json index a6031706be..9e681b775d 100644 --- a/packages/contract-addresses/CHANGELOG.json +++ b/packages/contract-addresses/CHANGELOG.json @@ -1,6 +1,6 @@ [ { - "version": "3.3.0-beta.1", + "version": "3.4.0-beta.0", "changes": [ { "note": "Remove `readOnlyProxy` from addresses interface", @@ -14,8 +14,7 @@ "note": "Update `exchange`, `staking`, `stakingProxy`, `zeroExGovernor`, `assetProxyOwner`, and `erc20BridgeProxy` addresses for each tesnet", "pr": 2296 } - ], - "timestamp": 1573001598 + ] }, { "version": "3.3.0-beta.0", diff --git a/packages/contract-addresses/CHANGELOG.md b/packages/contract-addresses/CHANGELOG.md index 2b371cc63e..1237f7d52c 100644 --- a/packages/contract-addresses/CHANGELOG.md +++ b/packages/contract-addresses/CHANGELOG.md @@ -5,17 +5,9 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.3.0-beta.1 - _November 6, 2019_ - - * Remove `readOnlyProxy` from addresses interface (#2295) - * Add `zeroExGovernor` and `erc20BridgeProxy` to addresses interface (#2296) - * Update `exchange`, `staking`, `stakingProxy`, `zeroExGovernor`, `assetProxyOwner`, and `erc20BridgeProxy` addresses for each tesnet (#2296) - ## v3.3.0-beta.0 - _October 3, 2019_ * Removed `getNetworkIdByExchangeAddressOrThrow`. It's not needed with V3 tooling. (#2170) - * Add `zrxVault`, `readOnlyProxy`, `staking`, and `stakingProxy` schema with addresses for each tesnet (#2224) - * Update `assetProxyOwner` address for each testnet (#2224) ## v3.2.0 - _September 17, 2019_ diff --git a/packages/contract-artifacts/CHANGELOG.json b/packages/contract-artifacts/CHANGELOG.json index 440f6040fa..3d4216c4ba 100644 --- a/packages/contract-artifacts/CHANGELOG.json +++ b/packages/contract-artifacts/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.3.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.3.0-beta.0", "changes": [ diff --git a/packages/contract-artifacts/CHANGELOG.md b/packages/contract-artifacts/CHANGELOG.md index cc32407f9f..4805ebf53d 100644 --- a/packages/contract-artifacts/CHANGELOG.md +++ b/packages/contract-artifacts/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.3.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.3.0-beta.0 - _October 3, 2019_ * Use V3 contracts (#2181) diff --git a/packages/contract-wrappers/CHANGELOG.json b/packages/contract-wrappers/CHANGELOG.json index ad926c1357..966692cae0 100644 --- a/packages/contract-wrappers/CHANGELOG.json +++ b/packages/contract-wrappers/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "12.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "12.2.0-beta.0", "changes": [ diff --git a/packages/contract-wrappers/CHANGELOG.md b/packages/contract-wrappers/CHANGELOG.md index 9e779870f2..cd13f04bd6 100644 --- a/packages/contract-wrappers/CHANGELOG.md +++ b/packages/contract-wrappers/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v12.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v12.2.0-beta.0 - _October 3, 2019_ * Use new `Order` and `ZeroExTransaction` structures with `domain` field (#1742) diff --git a/packages/contract-wrappers/docs/reference.mdx b/packages/contract-wrappers/docs/reference.mdx index 43fff34910..3761684f44 100644 --- a/packages/contract-wrappers/docs/reference.mdx +++ b/packages/contract-wrappers/docs/reference.mdx @@ -1,20514 +1,3 @@ - - -# Class: CoordinatorRegistryContract - - -## Constructors - - - -\+ **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_registry.ts:473](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L473)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | CoordinatorRegistryContract.deployedBytecode | - -**Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* - -## Properties - -### 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`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:457](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L457)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | The CoordinatorRegistry contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:415](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L415)* - -Subscribe to an event type emitted by the CoordinatorRegistry contract. - -**Type parameters:** - -▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | - | The CoordinatorRegistry contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:440](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L440)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:446](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L446)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L343)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:301](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L301)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:270](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L270)* - -**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 - -### getCoordinatorEndpoint - -#### ▪ **getCoordinatorEndpoint**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:218](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L218)* - -Gets the endpoint for a Coordinator. - -#### callAsync - -▸ **callAsync**(`coordinatorOperator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:225](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L225)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`coordinatorOperator` | string | - | operator of the Coordinator endpoint. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -___ - -### setCoordinatorEndpoint - -#### ▪ **setCoordinatorEndpoint**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:56](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L56)* - -Called by a Coordinator operator to set the endpoint of their Coordinator. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:99](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L99)* - -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 | ------- | ------ | ------ | ------ | -`coordinatorEndpoint` | string | - | endpoint of the Coordinator. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`coordinatorEndpoint`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:150](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L150)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`coordinatorEndpoint` | string | - | endpoint of the Coordinator. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:125](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L125)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`coordinatorEndpoint` | string | endpoint of the Coordinator. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`coordinatorEndpoint`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:198](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L198)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`coordinatorEndpoint` | string | endpoint of the Coordinator. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:209](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L209)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:64](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L64)* - -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 | ------- | ------ | ------ | ------ | -`coordinatorEndpoint` | string | - | endpoint of the Coordinator. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: DevUtilsContract - - -## Constructors - - - -\+ **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/dev_utils.ts:3800](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3800)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DevUtilsContract.deployedBytecode | - -**Returns:** *[DevUtilsContract](#class-devutilscontract)* - -## Properties - -#### 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/dev_utils.ts:2534](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2534)* - -**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/dev_utils.ts:2487](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2487)* - -**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/dev_utils.ts:2454](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2454)* - -**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 - -### decodeAssetProxyDispatchError - -#### ▪ **decodeAssetProxyDispatchError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L45)* - -Decompose an ABI-encoded AssetProxyDispatchError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[number, string, string]>`* - -errorCode The error code.orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched. - -___ - -### decodeAssetProxyExistsError - -#### ▪ **decodeAssetProxyExistsError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L90)* - -Decompose an ABI-encoded AssetProxyExistsError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string]>`* - -assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy. - -___ - -### decodeAssetProxyTransferError - -#### ▪ **decodeAssetProxyTransferError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L135)* - -Decompose an ABI-encoded AssetProxyTransferError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:143](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L143)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string, string]>`* - -orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched.errorData ABI-encoded revert data from the asset proxy. - -___ - -### decodeEIP1271SignatureError - -#### ▪ **decodeEIP1271SignatureError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:180](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L180)* - -Decompose an ABI-encoded SignatureValidatorError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:188](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L188)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string, string, string]>`* - -signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. - -___ - -### decodeERC1155AssetData - -#### ▪ **decodeERC1155AssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:225](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L225)* - -Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. - -#### callAsync - -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:234](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L234)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* - -The ERC-1155 AssetProxy identifier, the address of the ERC-1155 contract hosting the assets, an array of the identifiers of the assets to be traded, an array of asset amounts to be traded, and callback data. Each element of the arrays corresponds to the same-indexed element of the other array. Return values specified as `memory` are returned as pointers to locations within the memory of the input parameter `assetData`. - -___ - -### decodeERC20AssetData - -#### ▪ **decodeERC20AssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:273](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L273)* - -Decode ERC-20 asset data from the format described in the AssetProxy contract specification. - -#### callAsync - -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:281](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L281)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-20 asset. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string]>`* - -The ERC-20 AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. - -___ - -### decodeERC721AssetData - -#### ▪ **decodeERC721AssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:318](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L318)* - -Decode ERC-721 asset data from the format described in the AssetProxy contract specification. - -#### callAsync - -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:327](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.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 | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-721 asset. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string, BigNumber]>`* - -The ERC-721 AssetProxy identifier, the address of the ERC-721 contract hosting this asset, and the identifier of the specific asset to be traded. - -___ - -### decodeExchangeInvalidContextError - -#### ▪ **decodeExchangeInvalidContextError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:364](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L364)* - -Decompose an ABI-encoded OrderStatusError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:372](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L372)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[number, string, string]>`* - -errorCode Error code that corresponds to invalid maker, taker, or sender.orderHash The order hash.contextAddress The maker, taker, or sender address - -___ - -### decodeFillError - -#### ▪ **decodeFillError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:409](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L409)* - -Decompose an ABI-encoded FillError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L417)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[number, string]>`* - -errorCode The error code.orderHash The order hash. - -___ - -### decodeIncompleteFillError - -#### ▪ **decodeIncompleteFillError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:454](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L454)* - -Decompose an ABI-encoded IncompleteFillError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, BigNumber, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:462](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L462)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[number, BigNumber, BigNumber]>`* - -orderHash Hash of the order being filled. - -___ - -### decodeMultiAssetData - -#### ▪ **decodeMultiAssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:499](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L499)* - -Decode multi-asset data from the format described in the AssetProxy contract specification. - -#### callAsync - -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, BigNumber[], string[]]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:507](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L507)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant data describing a multi-asset basket. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, BigNumber[], string[]]>`* - -The Multi-Asset AssetProxy identifier, an array of the amounts of the assets to be traded, and an array of the AssetProxy-compliant data describing each asset to be traded. Each element of the arrays corresponds to the same-indexed element of the other array. - -___ - -### decodeNegativeSpreadError - -#### ▪ **decodeNegativeSpreadError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:544](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L544)* - -Decompose an ABI-encoded NegativeSpreadError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:552](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L552)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string]>`* - -leftOrderHash Hash of the left order being matched.rightOrderHash Hash of the right order being matched. - -___ - -### decodeOrderEpochError - -#### ▪ **decodeOrderEpochError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:589](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L589)* - -Decompose an ABI-encoded OrderEpochError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:597](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L597)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string, BigNumber]>`* - -makerAddress The order maker.orderSenderAddress The order sender.currentEpoch The current epoch for the maker. - -___ - -### decodeOrderStatusError - -#### ▪ **decodeOrderStatusError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:634](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L634)* - -Decompose an ABI-encoded OrderStatusError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, number]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:642](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L642)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, number]>`* - -orderHash The order hash.orderStatus The order status. - -___ - -### decodeSignatureError - -#### ▪ **decodeSignatureError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:679](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L679)* - -Decompose an ABI-encoded SignatureError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:687](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L687)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[number, string, string, string]>`* - -errorCode The error code.signerAddress The expected signer of the hash.signature The full signature. - -___ - -### decodeSignatureValidatorNotApprovedError - -#### ▪ **decodeSignatureValidatorNotApprovedError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:724](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L724)* - -Decompose an ABI-encoded SignatureValidatorNotApprovedError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:732](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L732)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string]>`* - -signerAddress The expected signer of the hash.validatorAddress The expected validator. - -___ - -### decodeSignatureWalletError - -#### ▪ **decodeSignatureWalletError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:771](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L771)* - -Decompose an ABI-encoded SignatureWalletError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:779](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L779)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`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. - -___ - -### decodeTransactionError - -#### ▪ **decodeTransactionError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:816](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L816)* - -Decompose an ABI-encoded TransactionError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:824](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L824)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[number, string]>`* - -errorCode The error code.transactionHash Hash of the transaction. - -___ - -### decodeTransactionExecutionError - -#### ▪ **decodeTransactionExecutionError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:861](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L861)* - -Decompose an ABI-encoded TransactionExecutionError. - -#### callAsync - -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:869](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L869)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string]>`* - -transactionHash Hash of the transaction.errorData Error thrown by exeucteTransaction(). - -___ - -### decodeZeroExTransactionData - -#### ▪ **decodeZeroExTransactionData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:906](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L906)* - -Decodes the call data for an Exchange contract method call. - -#### callAsync - -▸ **callAsync**(`transactionData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, Array, BigNumber[], string[]]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:915](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L915)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`transactionData` | string | - | ABI-encoded calldata for an Exchange contract method call. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, Array, BigNumber[], string[]]>`* - -The name of the function called, and the parameters it was given. For single-order fills and cancels, the arrays will have just one element. - -___ - -### encodeERC1155AssetData - -#### ▪ **encodeERC1155AssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:996](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L996)* - -Encode ERC-1155 asset data into the format described in the AssetProxy contract specification. - -#### callAsync - -▸ **callAsync**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1009](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1009)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The address of the ERC-1155 contract hosting the asset(s) to be traded. | -`tokenIds` | `BigNumber`[] | - | The identifiers of the specific assets to be traded. | -`tokenValues` | `BigNumber`[] | - | The amounts of each asset to be traded. | -`callbackData` | string | - | Data to be passed to receiving contracts when a transfer is performed. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -AssetProxy-compliant asset data describing the set of assets. - -___ - -### encodeERC20AssetData - -#### ▪ **encodeERC20AssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1055](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1055)* - -Encode ERC-20 asset data into the format described in the AssetProxy contract specification. - -#### callAsync - -▸ **callAsync**(`tokenAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1064](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1064)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The address of the ERC-20 contract hosting the asset to be traded. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -AssetProxy-compliant data describing the asset. - -___ - -### encodeERC721AssetData - -#### ▪ **encodeERC721AssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1103)* - -Encode ERC-721 asset data into the format described in the AssetProxy specification. - -#### callAsync - -▸ **callAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1113](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.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 | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The address of the ERC-721 contract hosting the asset to be traded. | -`tokenId` | `BigNumber` | - | The identifier of the specific asset to be traded. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -AssetProxy-compliant asset data describing the asset. - -___ - -### encodeMultiAssetData - -#### ▪ **encodeMultiAssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1155](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1155)* - -Encode data for multiple assets, per the AssetProxy contract specification. - -#### callAsync - -▸ **callAsync**(`amounts`: `BigNumber`[], `nestedAssetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1165](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1165)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`amounts` | `BigNumber`[] | - | The amounts of each asset to be traded. | -`nestedAssetData` | string[] | - | AssetProxy-compliant data describing each asset to be traded. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -AssetProxy-compliant data describing the set of assets. - -___ - -### getAssetProxyAllowance - -#### ▪ **getAssetProxyAllowance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1207](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1207)* - -Returns the number of asset(s) (described by assetData) that the corresponding AssetProxy contract is authorized to spend. When the asset data contains multiple assets (eg for Multi-Asset), the return value indicates how many complete "baskets" of those assets may be spent by all of the corresponding AssetProxy contracts. - -#### callAsync - -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1217](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1217)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`ownerAddress` | string | - | Owner of the assets specified by assetData. | -`assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. - -___ - -### getBalance - -#### ▪ **getBalance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1267](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1267)* - -Returns the owner's balance of the assets(s) specified in assetData. When the asset data contains multiple assets (eg in ERC1155 or Multi-Asset), the return value indicates how many complete "baskets" of those assets are owned by owner. - -#### callAsync - -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1277](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1277)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`ownerAddress` | string | - | Owner of the assets specified by assetData. | -`assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Number of assets (or asset baskets) held by owner. - -___ - -### getBalanceAndAssetProxyAllowance - -#### ▪ **getBalanceAndAssetProxyAllowance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1327](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1327)* - -Calls getBalance() and getAllowance() for assetData. - -#### callAsync - -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1337](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1337)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`ownerAddress` | string | - | Owner of the assets specified by assetData. | -`assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[BigNumber, BigNumber]>`* - -Number of assets (or asset baskets) held by owner, and number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. - -___ - -### getBatchAssetProxyAllowances - -#### ▪ **getBatchAssetProxyAllowances**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1387](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1387)* - -Calls getAssetProxyAllowance() for each element of assetData. - -#### callAsync - -▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1397](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1397)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`ownerAddress` | string | - | Owner of the assets specified by assetData. | -`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. - -___ - -### getBatchBalances - -#### ▪ **getBatchBalances**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1447](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1447)* - -Calls getBalance() for each element of assetData. - -#### callAsync - -▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1457](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1457)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`ownerAddress` | string | - | Owner of the assets specified by assetData. | -`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input. - -___ - -### getBatchBalancesAndAssetProxyAllowances - -#### ▪ **getBatchBalancesAndAssetProxyAllowances**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1507](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1507)* - -Calls getBatchBalances() and getBatchAllowances() for each element of assetData. - -#### callAsync - -▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1517](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1517)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`ownerAddress` | string | - | Owner of the assets specified by assetData. | -`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* - -An array of asset balances from getBalance(), and an array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. - -___ - -### getEthBalances - -#### ▪ **getEthBalances**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1567](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1567)* - -Batch fetches ETH balances - -#### callAsync - -▸ **callAsync**(`addresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1575](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1575)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`addresses` | string[] | - | Array of addresses. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Array of ETH balances. - -___ - -### getOrderRelevantState - -#### ▪ **getOrderRelevantState**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1620](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1620)* - -Fetches all order-relevant information needed to validate if the supplied order is fillable. - -#### callAsync - -▸ **callAsync**(`order`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, BigNumber, boolean]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1631](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1631)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The order structure. | -`signature` | string | - | Signature provided by maker that proves the order's authenticity. `0x01` can always be provided if the signature does not need to be validated. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[object, BigNumber, boolean]>`* - -The orderInfo (hash, status, and `takerAssetAmount` already filled for the given order), fillableTakerAssetAmount (amount of the order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (validity of the provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, `fillableTakerAssetAmount` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. - -___ - -### getOrderRelevantStates - -#### ▪ **getOrderRelevantStates**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1701](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1701)* - -Fetches all order-relevant information needed to validate if the supplied orders are fillable. - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, BigNumber[], boolean[]]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1712](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1712)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order structures. | -`signatures` | string[] | - | Array of signatures provided by makers that prove the authenticity of the orders. `0x01` can always be provided if a signature does not need to be validated. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[Array, BigNumber[], boolean[]]>`* - -The ordersInfo (array of the hash, status, and `takerAssetAmount` already filled for each order), fillableTakerAssetAmounts (array of amounts for each order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (array containing the validity of each provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, each element of `fillableTakerAssetAmounts` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. - -___ - -### getSimulatedOrderTransferResults - -#### ▪ **getSimulatedOrderTransferResults**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1791](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1791)* - -Simulates all of the transfers within an order and returns the index of the first failed transfer. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1866](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1866)* - -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 } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1972](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1972)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 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) | - | - | - -**Returns:** *`Promise`* - -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 [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1919](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1919)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**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 | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2046](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2046)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | The order to simulate transfers for. | -`takerAddress` | string | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2078](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2078)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1802](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1802)* - -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 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 } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### getSimulatedOrdersTransferResults - -#### ▪ **getSimulatedOrdersTransferResults**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2089](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2089)* - -Simulates all of the transfers for each given order and returns the indices of each first failed transfer. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2167](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2167)* - -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 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 } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2277](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2277)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 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) | - | - | - -**Returns:** *`Promise`* - -The indices of the first failed transfer (or 4 if all transfers are successful) for each order. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2222](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2222)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**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 | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2353](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2353)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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 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:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2386](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2386)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2101](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2101)* - -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 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 } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### getTransferableAssetAmount - -#### ▪ **getTransferableAssetAmount**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2397](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2397)* - -Gets the amount of an asset transferable by the owner. - -#### callAsync - -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2407](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2407)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`ownerAddress` | string | - | Address of the owner of the asset. | -`assetData` | string | - | Description of tokens, per the AssetProxy contract specification. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -The amount of the asset tranferable by the owner. NOTE: If the `assetData` encodes data for multiple assets, the `transferableAssetAmount` will represent the amount of times the entire `assetData` can be transferred. To calculate the total individual transferable amounts, this scaled `transferableAmount` must be multiplied by the individual asset amounts located within the `assetData`. - -
- -# Class: DummyERC20TokenContract - - -## Constructors - - - -\+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1985](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1985)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DummyERC20TokenContract.deployedBytecode | - -**Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* - -## Properties - -#### 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`: [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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1969)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents) | The DummyERC20Token contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1927](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1927)* - -Subscribe to an event type emitted by the DummyERC20Token contract. - -**Type parameters:** - -▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents) | - | The DummyERC20Token contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1952](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1952)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1958](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1958)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1598](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1598)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1548](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1548)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | -`_decimals` | `BigNumber` | -`_totalSupply` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1509](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1509)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | -`_decimals` | `BigNumber` | -`_totalSupply` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:41 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### MAX_MINT_AMOUNT - -#### ▪ **MAX_MINT_AMOUNT**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L61)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:67](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L67)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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`* - -___ - -### allowance - -#### ▪ **allowance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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 [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:113](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**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/dummy_erc20_token.ts:163](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L163)* - -`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/dummy_erc20_token.ts:213](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L213)* - -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/dummy_erc20_token.ts:277](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L277)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_spender` | string | - | The address of the account able to transfer the tokens | -`_value` | `BigNumber` | - | The amount of wei to be approved for transfer | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Always true if the call has enough gas to complete execution - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:242](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L242)* - -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/dummy_erc20_token.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L331)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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/dummy_erc20_token.ts:344](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L344)* - -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/dummy_erc20_token.ts:172](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L172)* - -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/dummy_erc20_token.ts:353](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L353)* - -Query the balance of owner - -#### callAsync - -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:361](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L361)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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 - -___ - -### decimals - -#### ▪ **decimals**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:403](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L403)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:409](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L409)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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`* - -___ - -### mint - -#### ▪ **mint**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:449](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L449)* - -Mints new tokens for sender - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:492](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L492)* - -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 | ------- | ------ | ------ | ------ | -`_value` | `BigNumber` | - | Amount of tokens to mint | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:543](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L543)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_value` | `BigNumber` | - | Amount of tokens to mint | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:518](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L518)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_value` | `BigNumber` | Amount of tokens to mint | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:587](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L587)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_value` | `BigNumber` | Amount of tokens to mint | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:596](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L596)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:457](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L457)* - -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 | ------- | ------ | ------ | ------ | -`_value` | `BigNumber` | - | Amount of tokens to mint | -`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/dummy_erc20_token.ts:602](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L602)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:608](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L608)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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`* - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:645](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L645)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:651](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L651)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### setBalance - -#### ▪ **setBalance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:691](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L691)* - -Sets the balance of target address - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:741](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L741)* - -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 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`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_target`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:804](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_target` | string | - | Address or which balance will be updated | -`_value` | `BigNumber` | - | New balance of target address | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:770](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L770)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_target` | string | Address or which balance will be updated | -`_value` | `BigNumber` | New balance of target address | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_target`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:858](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L858)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_target` | string | Address or which balance will be updated | -`_value` | `BigNumber` | New balance of target address | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:871](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L871)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:700](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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:** - -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`* - -The hash of the transaction - -___ - -### symbol - -#### ▪ **symbol**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:877](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L877)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:883](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L883)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/dummy_erc20_token.ts:923](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L923)* - -Query total supply of token - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:930](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L930)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/dummy_erc20_token.ts:970](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L970)* - -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/dummy_erc20_token.ts:1017](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1017)* - -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/dummy_erc20_token.ts:1074](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1074)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | The address of the recipient | -`_value` | `BigNumber` | - | The amount of token to be transferred | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -True if transfer was successful - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1046](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1046)* - -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/dummy_erc20_token.ts:1125](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1125)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_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/dummy_erc20_token.ts:1138](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1138)* - -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/dummy_erc20_token.ts:979](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L979)* - -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/dummy_erc20_token.ts:1147](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1147)* - -ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. See https://github.com/ethereum/EIPs/issues/717 - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1202](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1202)* - -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 | - | 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`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1279](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1279)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | Address to transfer from. | -`_to` | string | - | Address to transfer to. | -`_value` | `BigNumber` | - | Amount to transfer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Success of transfer. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1240](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1240)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1337](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1337)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1352](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1352)* - -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/dummy_erc20_token.ts:1157](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1157)* - -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 | - | 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 - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1358](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1358)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1399](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1399)* - -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_erc20_token.ts:1448](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1448)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`newOwner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1424](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1424)* - -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_erc20_token.ts:1491](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1491)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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_erc20_token.ts:1502](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1502)* - -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_erc20_token.ts:1365](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1365)* - -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: DummyERC721TokenContract - - -## Constructors - - - -\+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2500](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2500)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DummyERC721TokenContract.deployedBytecode | - -**Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* - -## Properties - -#### 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`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2484](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2484)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents) | The DummyERC721Token contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2442](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2442)* - -Subscribe to an event type emitted by the DummyERC721Token contract. - -**Type parameters:** - -▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents) | - | The DummyERC721Token contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2467](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2467)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2473](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2473)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2065](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2065)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2017](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2017)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1982](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1982)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:41 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### approve - -#### ▪ **approve**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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/dummy_erc721_token.ts:126](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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/dummy_erc721_token.ts:189](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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/dummy_erc721_token.ts:155](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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/dummy_erc721_token.ts:243](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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/dummy_erc721_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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/dummy_erc721_token.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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/dummy_erc721_token.ts:266](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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/dummy_erc721_token.ts:274](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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 - -___ - -### burn - -#### ▪ **burn**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:320](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L320)* - -Function to burn a token -Reverts if the given token ID doesn't exist or not called by contract owner - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:367](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L367)* - -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 | ------- | ------ | ------ | ------ | -`_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 } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:427](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L427)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_owner` | string | - | Owner of token with given token ID | -`_tokenId` | `BigNumber` | - | ID of the token to be burned by the msg.sender | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:396](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | Owner of token with given token ID | -`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:478](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.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 | ------- | ------ | ------ | -`_owner` | string | Owner of token with given token ID | -`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:491](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L491)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L329)* - -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 | ------- | ------ | ------ | ------ | -`_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 } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### getApproved - -#### ▪ **getApproved**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:500](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L500)* - -Throws if `_tokenId` is not a valid NFT. - -#### callAsync - -▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:508](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**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/dummy_erc721_token.ts:550](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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). - -**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/44793a9cf/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/44793a9cf/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 } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### name - -#### ▪ **name**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:787](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L787)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:793](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L793)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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`* - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:830](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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:** *`Promise`* - -___ - -### ownerOf - -#### ▪ **ownerOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:877](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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 - -▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:885](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**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/dummy_erc721_token.ts:931](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1024](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1024)* - -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:1120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1120)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:1135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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:** - -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/dummy_erc721_token.ts:1150](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1252](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1252)* - -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/dummy_erc721_token.ts:1356](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1356)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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/dummy_erc721_token.ts:1371](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1371)* - -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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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* - - - -Defined in base-contract/lib/src/index.d.ts:41 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### getBalanceAndAllowance - -#### ▪ **getBalanceAndAllowance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L136)* - -#### callAsync - -▸ **callAsync**(`target`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:142](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.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 | ------- | ------ | ------ | -`target` | string | - | -`assetData` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[BigNumber, BigNumber]>`* - -___ - -### getBalancesAndAllowances - -#### ▪ **getBalancesAndAllowances**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:428](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L428)* - -#### callAsync - -▸ **callAsync**(`target`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L434)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`target` | string | - | -`assetData` | string[] | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* - -___ - -### getERC721TokenOwner - -#### ▪ **getERC721TokenOwner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:375](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L375)* - -#### callAsync - -▸ **callAsync**(`token`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:381](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L381)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`token` | string | - | -`tokenId` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### getOrderAndTraderInfo - -#### ▪ **getOrderAndTraderInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:41](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L41)* - -#### callAsync - -▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, object]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L47)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`order` | object | - | -`takerAddress` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[object, object]>`* - -___ - -### getOrdersAndTradersInfo - -#### ▪ **getOrdersAndTradersInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:189](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L189)* - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, Array]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:195](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L195)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`orders` | `Array` | - | -`takerAddresses` | string[] | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[Array, Array]>`* - -___ - -### getTraderInfo - -#### ▪ **getTraderInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:481](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L481)* - -#### callAsync - -▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:487](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L487)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`order` | object | - | -`takerAddress` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### getTradersInfo - -#### ▪ **getTradersInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:285](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L285)* - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:291](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L291)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`orders` | `Array` | - | -`takerAddresses` | string[] | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise>`* - -
- -# 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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 - -#### 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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`* - -___ - -### `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/zrx_token.ts:834](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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 } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### balanceOf - -#### ▪ **balanceOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:580](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L580)* - -#### callAsync - -▸ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L586)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`_owner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### decimals - -#### ▪ **decimals**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:537](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L537)* - -#### 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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L543)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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`* - -___ - -### name - -#### ▪ **name**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L61)* - -#### callAsync - -▸ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L67)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/zrx_token.ts:628](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L628)* - -#### callAsync - -▸ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L634)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/zrx_token.ts:280](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L280)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:286](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L286)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/zrx_token.ts:671](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L671)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:714](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L714)* - -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 | - | - | -`_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**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:766](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.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 | ------- | ------ | ------ | -`_to` | string | - | -`_value` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:741](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L741)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | - | -`_value` | `BigNumber` | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:815](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L815)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`_to` | string | -`_value` | `BigNumber` | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L828)* - -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/zrx_token.ts:678](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L678)* - -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 | - | - | -`_value` | `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/zrx_token.ts:326](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L326)* - -ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. - -#### awaitTransactionSuccessAsync - -▸ **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/44793a9cf/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. - -**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 } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:458](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L458)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | Address to transfer from. | -`_to` | string | - | Address to transfer to. | -`_value` | `BigNumber` | - | Amount to transfer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Success of transfer. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:419](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L419)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **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/44793a9cf/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). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:531](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L531)* - -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/zrx_token.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L336)* - -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 | - | 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 - -
- -# Class: ContractWrappers - -The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. - - -## Constructors - - - -\+ **new ContractWrappers**(`supportedProvider`: [SupportedProvider](#supportedprovider), `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L84)* - -Instantiates a new ContractWrappers instance. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | The Provider instance you would like the contract-wrappers library to use for interacting with the Ethereum network. | -`config` | [ContractWrappersConfig](#interface-contractwrappersconfig) | The configuration object. Look up the type for the description. | - -**Returns:** *[ContractWrappers](#class-contractwrappers)* - -An instance of the ContractWrappers class. - -## Properties - -#### contractAddresses - -• **contractAddresses**: *`ContractAddresses`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L43)* - -An index of the default contract addresses for this network. - -___ - -### coordinator - -• **coordinator**: *[CoordinatorWrapper](#class-coordinatorwrapper)* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:82](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L82)* - -An instance of the CoordinatorWrapper class containing methods for interacting with the Coordinator extension contract. - -___ - -### devUtils - -• **devUtils**: *`DevUtilsContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L78)* - -An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract. - -___ - -### dutchAuction - -• **dutchAuction**: *`DutchAuctionContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L74)* - -An instance of the DutchAuctionContract class containing methods for interacting with any DutchAuction smart contract. - -___ - -### erc20Proxy - -• **erc20Proxy**: *`ERC20ProxyContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L52)* - -An instance of the ERC20ProxyContract class containing methods for interacting with the -erc20Proxy smart contract. - -___ - -### erc721Proxy - -• **erc721Proxy**: *`ERC721ProxyContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:57](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L57)* - -An instance of the ERC721ProxyContract class containing methods for interacting with the -erc721Proxy smart contract. - -___ - -### exchange - -• **exchange**: *`ExchangeContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L47)* - -An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. - -___ - -### forwarder - -• **forwarder**: *`ForwarderContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L66)* - -An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. - -___ - -### orderValidator - -• **orderValidator**: *`OrderValidatorContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L70)* - -An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract. - -___ - -### weth9 - -• **weth9**: *`WETH9Contract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:62](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L62)* - -An instance of the WETH9Contract class containing methods for interacting with the -WETH9 smart contract. - -## Methods - -### getAbiDecoder - -▸ **getAbiDecoder**(): *`AbiDecoder`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:155](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L155)* - -Get the abi decoder instance currently used by contract-wrappers - -**Returns:** *`AbiDecoder`* - -AbiDecoder instance - -___ - -### getProvider - -▸ **getProvider**(): *[SupportedProvider](#supportedprovider)* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:148](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L148)* - -Get the provider instance currently used by contract-wrappers - -**Returns:** *[SupportedProvider](#supportedprovider)* - -Web3 provider instance - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:138](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/contract_wrappers.ts#L138)* - -Unsubscribes from all subscriptions for all contracts. - -**Returns:** *void* - -
- -# Class: CoordinatorWrapper - -This class includes all the functionality related to filling or cancelling orders through -the 0x V2 Coordinator extension contract. - - -## Constructors - - - -\+ **new CoordinatorWrapper**(`provider`: [SupportedProvider](#supportedprovider), `networkId`: number, `address?`: undefined | string, `exchangeAddress?`: undefined | string, `registryAddress?`: undefined | string): *[CoordinatorWrapper](#class-coordinatorwrapper)* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L43)* - -Instantiate CoordinatorWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`provider` | [SupportedProvider](#supportedprovider) | - | -`networkId` | number | Desired networkId. | -`address?` | undefined \| string | The address of the Coordinator contract. If undefined, will default to the known address corresponding to the networkId. | -`exchangeAddress?` | undefined \| string | The address of the Exchange contract. If undefined, will default to the known address corresponding to the networkId. | -`registryAddress?` | undefined \| string | The address of the CoordinatorRegistry contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[CoordinatorWrapper](#class-coordinatorwrapper)* - -## Properties - -### abi - -• **abi**: *[ContractAbi](#contractabi)* = Coordinator.compilerOutput.abi - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L34)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L36)* - -___ - -### exchangeAddress - -• **exchangeAddress**: *string* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L37)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L35)* - -___ - -### registryAddress - -• **registryAddress**: *string* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L38)* - -## Methods - -### assertValidCoordinatorApprovalsOrThrowAsync - -▸ **assertValidCoordinatorApprovalsOrThrowAsync**(`transaction`: `ZeroExTransaction`, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:529](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L529)* - -Validates that the 0x transaction has been approved by all of the feeRecipients that correspond to each order in the transaction's Exchange calldata. -Throws an error if the transaction approvals are not valid. Will not detect failures that would occur when the transaction is executed on the Exchange contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | `ZeroExTransaction` | 0x transaction containing salt, signerAddress, and data. | -`txOrigin` | string | Required signer of Ethereum transaction calling this function. | -`transactionSignature` | string | Proof that the transaction has been signed by the signer. | -`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | -`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | - -**Returns:** *`Promise`* - -___ - -### batchFillOrKillOrdersAsync - -▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:241](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L241)* - -Batch version of fillOrKillOrderAsync. Executes multiple fills atomically in a single transaction. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### batchFillOrdersAsync - -▸ **batchFillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:171](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L171)* - -Batch version of fillOrderAsync. Executes multiple fills atomically in a single transaction. -Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints -registered in the coordinator registry contract. It requests a signature from each coordinator server before -submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the -signatures and then fills the order through the Exchange contract. -If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### batchFillOrdersNoThrowAsync - -▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:206](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L206)* - -No throw version of batchFillOrdersAsync - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### batchHardCancelOrdersAsync - -▸ **batchHardCancelOrdersAsync**(`orders`: `SignedOrder`[], `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:460](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `SignedOrder`[] | - | An array of orders to cancel. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### batchSoftCancelOrdersAsync - -▸ **batchSoftCancelOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:374](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L374)* - -Batch version of softCancelOrderAsync. Requests multiple soft cancels - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | An array of orders to cancel. | - -**Returns:** *`Promise`* - -CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response). - -___ - -### fillOrKillOrderAsync - -▸ **fillOrKillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:134](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L134)* - -Attempts to fill a specific amount of an order. If the entire amount specified cannot be filled, -the fill order is abandoned. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### fillOrderAsync - -▸ **fillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:101](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L101)* - -Fills a signed order with an amount denominated in baseUnits of the taker asset. Under-the-hood, this -method uses the `feeRecipientAddress` of the order to look up the coordinator server endpoint registered in the -coordinator registry contract. It requests a signature from that coordinator server before -submitting the order and signature as a 0x transaction to the coordinator extension contract. The coordinator extension -contract validates signatures and then fills the order via the Exchange contract. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### getSignerAddressAsync - -▸ **getSignerAddressAsync**(`hash`: string, `signature`: string): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:561](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L561)* - -Recovers the address of a signer given a hash and signature. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`hash` | string | Any 32 byte hash. | -`signature` | string | Proof that the hash has been signed by signer. | - -**Returns:** *`Promise`* - -Signer address. - -___ - -### hardCancelOrderAsync - -▸ **hardCancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:428](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L428)* - -Cancels an order on-chain by submitting an Ethereum transaction. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | `Order` \| `SignedOrder` | - | An object that conforms to the Order or SignedOrder interface. The order you would like to cancel. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### hardCancelOrdersUpToAsync - -▸ **hardCancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:495](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L495)* - -Cancels orders on-chain by submitting an Ethereum transaction. -Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch -and senderAddress equal to coordinator extension contract address. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`targetOrderEpoch` | `BigNumber` | - | Target order epoch. | -`senderAddress` | string | - | Address that should send the transaction. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### marketBuyOrdersNoThrowAsync - -▸ **marketBuyOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:276](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L276)* - -No throw version of marketBuyOrdersAsync - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`makerAssetFillAmount` | `BigNumber` | - | Maker asset fill amount. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### marketSellOrdersNoThrowAsync - -▸ **marketSellOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:309](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/coordinator_wrapper.ts#L309)* - -No throw version of marketSellOrdersAsync - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmount` | `BigNumber` | - | Taker asset fill amount. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### softCancelOrderAsync - -▸ **softCancelOrderAsync**(`order`: `Order` | `SignedOrder`): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:339](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | `Order` \| `SignedOrder` | An object that conforms to the Order or SignedOrder interface. The order you would like to cancel. | - -**Returns:** *`Promise`* - -CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response). - -
- -# Class: 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/44793a9cf/packages/utils/src/abi_decoder.ts#L42)* - -Instantiate an AbiDecoder - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`abiArrays` | [AbiDefinition](#abidefinition)[][] | An array of contract ABI's | - -**Returns:** *[AbiDecoder](#class-abidecoder)* - -AbiDecoder instance - -## Methods - -### addABI - -▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void* - -*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/utils/src/abi_decoder.ts#L158)* - -Adds a set of ABI definitions, after which calldata and logs targeting these ABI's can be decoded. -Additional properties can be included to disambiguate similar ABI's. For example, if two functions -have the same signature but different parameter names, then their ABI definitions can be disambiguated -by specifying a contract name. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`abiArray` | [AbiDefinition](#abidefinition)[] | - | -`contractName?` | undefined \| string | Name of contract that encapsulates the ABI definitions (optional). This can be used when decoding calldata to disambiguate methods with the same signature but different parameter names. | - -**Returns:** *void* - -___ - -### decodeCalldataOrThrow - -▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* - -*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/utils/src/abi_decoder.ts#L118)* - -Decodes calldata for a known ABI. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`calldata` | string | hex-encoded calldata. | -`contractName?` | undefined \| string | used to disambiguate similar ABI's (optional). | - -**Returns:** *`DecodedCalldata`* - -Decoded calldata. Includes: function name and signature, along with the decoded arguments. - -___ - -### tryToDecodeLogOrNoop - -▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* - -*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/utils/src/abi_decoder.ts#L58)* - -Attempt to decode a log given the ABI's the AbiDecoder knows about. - -**Type parameters:** - -▪ **ArgsType**: *`DecodedLogArgs`* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`log` | `LogEntry` | The log to attempt to decode | - -**Returns:** *`LogWithDecodedArgs` | [RawLog](#rawlog)* - -The decoded log if the requisite ABI was available. Otherwise the log unaltered. - -
- -# Enumeration: CoordinatorRegistryEvents - - -## Enumeration members - -### CoordinatorEndpointSet - -• **CoordinatorEndpointSet**: = "CoordinatorEndpointSet" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L37)* - -
- -# Enumeration: DummyERC20TokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L38)* - -
- -# Enumeration: DummyERC721TokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L40)* - -___ - -### ApprovalForAll - -• **ApprovalForAll**: = "ApprovalForAll" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L41)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L40)* - -
- -# Enumeration: ERC20TokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L38)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L40)* - -
- -# Enumeration: ERC721TokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L40)* - -___ - -### ApprovalForAll - -• **ApprovalForAll**: = "ApprovalForAll" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L41)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L42)* - -
- -# Enumeration: ExchangeEvents - - -## Enumeration members - -### AssetProxyRegistered - -• **AssetProxyRegistered**: = "AssetProxyRegistered" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L45)* - -___ - -### Cancel - -• **Cancel**: = "Cancel" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L46)* - -___ - -### CancelUpTo - -• **CancelUpTo**: = "CancelUpTo" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L47)* - -___ - -### Fill - -• **Fill**: = "Fill" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L48)* - -___ - -### ProtocolFeeCollectorAddress - -• **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L49)* - -___ - -### ProtocolFeeMultiplier - -• **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* - -___ - -### SignatureValidatorApproval - -• **SignatureValidatorApproval**: = "SignatureValidatorApproval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* - -___ - -### TransactionExecution - -• **TransactionExecution**: = "TransactionExecution" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)* - -
- -# Enumeration: WETH9Events - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:41](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L41)* - -___ - -### Deposit - -• **Deposit**: = "Deposit" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L43)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L42)* - -___ - -### Withdrawal - -• **Withdrawal**: = "Withdrawal" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* - -
- -# Enumeration: ZRXTokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L37)* - -
- - - -# Enumeration: ContractError - - -## Enumeration members - -### ContractNotDeployedOnNetwork - -• **ContractNotDeployedOnNetwork**: = "CONTRACT_NOT_DEPLOYED_ON_NETWORK" - -*Defined in [contract-wrappers/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L16)* - -___ - -### ERC721NoApproval - -• **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" - -*Defined in [contract-wrappers/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L26)* - -___ - -### ERC721OwnerNotFound - -• **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND" - -*Defined in [contract-wrappers/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L25)* - -___ - -### InsufficientAllowanceForTransfer - -• **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER" - -*Defined in [contract-wrappers/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L17)* - -___ - -### InsufficientBalanceForTransfer - -• **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER" - -*Defined in [contract-wrappers/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L18)* - -___ - -### InsufficientEthBalanceForDeposit - -• **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT" - -*Defined in [contract-wrappers/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L19)* - -___ - -### InsufficientWEthBalanceForWithdrawal - -• **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL" - -*Defined in [contract-wrappers/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L20)* - -___ - -### InvalidJump - -• **InvalidJump**: = "INVALID_JUMP" - -*Defined in [contract-wrappers/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L21)* - -___ - -### OutOfGas - -• **OutOfGas**: = "OUT_OF_GAS" - -*Defined in [contract-wrappers/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L22)* - -___ - -### SignatureRequestDenied - -• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" - -*Defined in [contract-wrappers/src/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L27)* - -___ - -### SubscriptionAlreadyPresent - -• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" - -*Defined in [contract-wrappers/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L24)* - -___ - -### SubscriptionNotFound - -• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" - -*Defined in [contract-wrappers/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L23)* - -
- -# Enumeration: ForwarderError - - -## Enumeration members - -### CompleteFillFailed - -• **CompleteFillFailed**: = "COMPLETE_FILL_FAILED" - -*Defined in [contract-wrappers/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L12)* - -
- - - - - -# Enumeration: BlockParamLiteral - - -## Enumeration members - -### Earliest - -• **Earliest**: = "earliest" - -*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L478)* - -___ - -### Latest - -• **Latest**: = "latest" - -*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L479)* - -___ - -### Pending - -• **Pending**: = "pending" - -*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L480)* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -# Interface: CoordinatorRegistryCoordinatorEndpointSetEventArgs - - -## Index - -### Properties - -* [coordinatorEndpoint](#coordinatorendpoint) -* [coordinatorOperator](#coordinatoroperator) - -## Properties - -### coordinatorEndpoint - -• **coordinatorEndpoint**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L42)* - -___ - -### coordinatorOperator - -• **coordinatorOperator**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:41](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L41)* - -
- -# Interface: DummyERC20TokenApprovalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L42)* - -___ - -### _spender - -• **_spender**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L43)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L44)* - -
- -# Interface: DummyERC20TokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L48)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L49)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L50)* - -
- -# Interface: DummyERC721TokenApprovalEventArgs - - -## Index - -### Properties - -* [_approved](#_approved) -* [_owner](#_owner) -* [_tokenId](#_tokenid) - -## Properties - -### _approved - -• **_approved**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L47)* - -___ - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L46)* - -___ - -### _tokenId - -• **_tokenId**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L48)* - -
- -# Interface: DummyERC721TokenApprovalForAllEventArgs - - -## Index - -### Properties - -* [_approved](#_approved) -* [_operator](#_operator) -* [_owner](#_owner) - -## Properties - -### _approved - -• **_approved**: *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L54)* - -___ - -### _operator - -• **_operator**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L53)* - -___ - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L52)* - -
- -# Interface: DummyERC721TokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_tokenId](#_tokenid) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L58)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L59)* - -___ - -### _tokenId - -• **_tokenId**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L49)* - -
- -# Interface: ERC20TokenApprovalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L48)* - -___ - -### _spender - -• **_spender**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L49)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L50)* - -
- -# Interface: ERC20TokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L42)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L43)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L49)* - -
- -# Interface: ERC721TokenApprovalEventArgs - - -## Index - -### Properties - -* [_approved](#_approved) -* [_owner](#_owner) -* [_tokenId](#_tokenid) - -## Properties - -### _approved - -• **_approved**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L47)* - -___ - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L46)* - -___ - -### _tokenId - -• **_tokenId**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L48)* - -
- -# Interface: ERC721TokenApprovalForAllEventArgs - - -## Index - -### Properties - -* [_approved](#_approved) -* [_operator](#_operator) -* [_owner](#_owner) - -## Properties - -### _approved - -• **_approved**: *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L54)* - -___ - -### _operator - -• **_operator**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L53)* - -___ - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L52)* - -
- -# Interface: ERC721TokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_tokenId](#_tokenid) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L58)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L59)* - -___ - -### _tokenId - -• **_tokenId**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L60)* - -
- -# Interface: ExchangeAssetProxyRegisteredEventArgs - - -## Index - -### Properties - -* [assetProxy](#assetproxy) -* [id](#id) - -## Properties - -### assetProxy - -• **assetProxy**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L57)* - -___ - -### id - -• **id**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L56)* - -
- -# Interface: ExchangeCancelEventArgs - - -## Index - -### Properties - -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetData](#makerassetdata) -* [orderHash](#orderhash) -* [senderAddress](#senderaddress) -* [takerAssetData](#takerassetdata) - -## Properties - -### feeRecipientAddress - -• **feeRecipientAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:62](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L62)* - -___ - -### makerAddress - -• **makerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L61)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L63)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* - -___ - -### senderAddress - -• **senderAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* - -
- -# Interface: ExchangeCancelUpToEventArgs - - -## Index - -### Properties - -* [makerAddress](#makeraddress) -* [orderEpoch](#orderepoch) -* [orderSenderAddress](#ordersenderaddress) - -## Properties - -### makerAddress - -• **makerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L70)* - -___ - -### orderEpoch - -• **orderEpoch**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L72)* - -___ - -### orderSenderAddress - -• **orderSenderAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:71](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L71)* - -
- -# Interface: ExchangeFillEventArgs - - -## Index - -### Properties - -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetData](#makerassetdata) -* [makerAssetFilledAmount](#makerassetfilledamount) -* [makerFeeAssetData](#makerfeeassetdata) -* [makerFeePaid](#makerfeepaid) -* [orderHash](#orderhash) -* [protocolFeePaid](#protocolfeepaid) -* [senderAddress](#senderaddress) -* [takerAddress](#takeraddress) -* [takerAssetData](#takerassetdata) -* [takerAssetFilledAmount](#takerassetfilledamount) -* [takerFeeAssetData](#takerfeeassetdata) -* [takerFeePaid](#takerfeepaid) - -## Properties - -### feeRecipientAddress - -• **feeRecipientAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:77](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L77)* - -___ - -### makerAddress - -• **makerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:76](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L76)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L78)* - -___ - -### makerAssetFilledAmount - -• **makerAssetFilledAmount**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)* - -___ - -### makerFeeAssetData - -• **makerFeeAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* - -___ - -### makerFeePaid - -• **makerFeePaid**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)* - -___ - -### protocolFeePaid - -• **protocolFeePaid**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:89](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L89)* - -___ - -### senderAddress - -• **senderAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L84)* - -___ - -### takerAddress - -• **takerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* - -___ - -### takerAssetFilledAmount - -• **takerAssetFilledAmount**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)* - -___ - -### takerFeeAssetData - -• **takerFeeAssetData**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* - -___ - -### takerFeePaid - -• **takerFeePaid**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)* - -
- -# Interface: ExchangeProtocolFeeCollectorAddressEventArgs - - -## Index - -### Properties - -* [oldProtocolFeeCollector](#oldprotocolfeecollector) -* [updatedProtocolFeeCollector](#updatedprotocolfeecollector) - -## Properties - -### oldProtocolFeeCollector - -• **oldProtocolFeeCollector**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L93)* - -___ - -### updatedProtocolFeeCollector - -• **updatedProtocolFeeCollector**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L94)* - -
- -# Interface: ExchangeProtocolFeeMultiplierEventArgs - - -## Index - -### Properties - -* [oldProtocolFeeMultiplier](#oldprotocolfeemultiplier) -* [updatedProtocolFeeMultiplier](#updatedprotocolfeemultiplier) - -## Properties - -### oldProtocolFeeMultiplier - -• **oldProtocolFeeMultiplier**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:98](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L98)* - -___ - -### updatedProtocolFeeMultiplier - -• **updatedProtocolFeeMultiplier**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:99](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L99)* - -
- -# Interface: ExchangeSignatureValidatorApprovalEventArgs - - -## Index - -### Properties - -* [isApproved](#isapproved) -* [signerAddress](#signeraddress) -* [validatorAddress](#validatoraddress) - -## Properties - -### isApproved - -• **isApproved**: *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:105](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L105)* - -___ - -### signerAddress - -• **signerAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L103)* - -___ - -### validatorAddress - -• **validatorAddress**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L104)* - -
- -# Interface: ExchangeTransactionExecutionEventArgs - - -## Index - -### Properties - -* [transactionHash](#transactionhash) - -## Properties - -### transactionHash - -• **transactionHash**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:109](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L109)* - -
- -# Interface: WETH9ApprovalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L48)* - -___ - -### _spender - -• **_spender**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L49)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L50)* - -
- -# Interface: WETH9DepositEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L60)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L61)* - -
- -# Interface: WETH9TransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L54)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:55](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L55)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:56](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L56)* - -
- -# Interface: WETH9WithdrawalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:65](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L65)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:66](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L66)* - -
- -# Interface: ZRXTokenApprovalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L48)* - -___ - -### _spender - -• **_spender**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L49)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L50)* - -
- -# Interface: ZRXTokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L42)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L43)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L44)* - -
- -# Interface: ContractAddresses - - -## Properties - -### assetProxyOwner - -• **assetProxyOwner**: *string* - -*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L10)* - -___ - -### coordinator - -• **coordinator**: *string* - -*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L16)* - -___ - -### coordinatorRegistry - -• **coordinatorRegistry**: *string* - -*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L15)* - -___ - -### devUtils - -• **devUtils**: *string* - -*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L20)* - -___ - -### dutchAuction - -• **dutchAuction**: *string* - -*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L14)* - -___ - -### erc1155Proxy - -• **erc1155Proxy**: *string* - -*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L19)* - -___ - -### erc20BridgeProxy - -• **erc20BridgeProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L24)* - -___ - -### erc20Proxy - -• **erc20Proxy**: *string* - -*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L4)* - -___ - -### erc721Proxy - -• **erc721Proxy**: *string* - -*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L5)* - -___ - -### etherToken - -• **etherToken**: *string* - -*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L7)* - -___ - -### exchange - -• **exchange**: *string* - -*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L9)* - -___ - -### exchangeV2 - -• **exchangeV2**: *string* - -*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L8)* - -___ - -### forwarder - -• **forwarder**: *string* - -*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L12)* - -___ - -### multiAssetProxy - -• **multiAssetProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L17)* - -___ - -### orderValidator - -• **orderValidator**: *string* - -*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L13)* - -___ - -### staking - -• **staking**: *string* - -*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L22)* - -___ - -### stakingProxy - -• **stakingProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L23)* - -___ - -### staticCallProxy - -• **staticCallProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L18)* - -___ - -### zeroExGovernor - -• **zeroExGovernor**: *string* - -*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L11)* - -___ - -### zrxToken - -• **zrxToken**: *string* - -*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L6)* - -___ - -### zrxVault - -• **zrxVault**: *string* - -*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L21)* - -
- -# Interface: ContractWrappersConfig - -networkId: The id of the underlying ethereum network your provider is connected to. (1-mainnet, 3-ropsten, 4-rinkeby, 42-kovan, 50-testrpc) -gasPrice: Gas price to use with every transaction -contractAddresses: The address of all contracts to use. Defaults to the known addresses based on networkId. -blockPollingIntervalMs: The interval to use for block polling in event watching methods (defaults to 1000) - - -## Properties - -### `Optional` blockPollingIntervalMs - -• **blockPollingIntervalMs**? : *undefined | number* - -*Defined in [contract-wrappers/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L40)* - -___ - -### `Optional` contractAddresses - -• **contractAddresses**? : *[ContractAddresses](#class-contractaddresses)* - -*Defined in [contract-wrappers/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L39)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Defined in [contract-wrappers/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L38)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [contract-wrappers/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-wrappers/src/types.ts#L37)* - -
- - - - - - - -# 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/contract-wrappers/src/types.ts#L61)* - -
- - - - - - - - - -# Interface: BlockRange - - -## Properties - -### fromBlock - -• **fromBlock**: *[BlockParam](#blockparam)* - -*Defined in [ethereum-types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L740)* - -___ - -### toBlock - -• **toBlock**: *[BlockParam](#blockparam)* - -*Defined in [ethereum-types/src/index.ts:741](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L741)* - -
- - - - - -# Interface: CallData - - -## Properties - -### `Optional` data - -• **data**? : *undefined | string* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* - -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* - -___ - -### `Optional` from - -• **from**? : *undefined | string* - -*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L402)* - -___ - -### `Optional` gas - -• **gas**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* - -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* - -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | number* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* - -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* - -___ - -### `Optional` to - -• **to**? : *undefined | string* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* - -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* - -___ - -### `Optional` value - -• **value**? : *number | string | `BigNumber`* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* - -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* - -
- - - - - -# Interface: CompilerOpts - - -## Properties - -### name - -• **name**: *"solc"* - -*Defined in [ethereum-types/src/index.ts:655](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L655)* - -___ - -### settings - -• **settings**: *[CompilerSettings](#class-compilersettings)* - -*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L657)* - -___ - -### version - -• **version**: *string* - -*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L656)* - -
- -# 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/44793a9cf/packages/ethereum-types/src/index.ts#L689)* - -___ - -### `Optional` libraries - -• **libraries**? : *undefined | object* - -*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L691)* - -___ - -### `Optional` metadata - -• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* - -*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L690)* - -___ - -### `Optional` optimizer - -• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* - -*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L688)* - -___ - -### outputSelection - -• **outputSelection**: *object* - -*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L696)* - -#### 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/44793a9cf/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/44793a9cf/packages/ethereum-types/src/index.ts#L704)* - -
- -# Interface: ConstructorAbi - - -## Properties - -### inputs - -• **inputs**: *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L103)* - -___ - -### payable - -• **payable**: *boolean* - -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L104)* - -___ - -### stateMutability - -• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* - -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L105)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L102)* - -
- -# Interface: ContractArtifact - -This type defines the schema of the artifact.json file generated by Sol-compiler -schemaVersion: The version of the artifact schema -contractName: The contract name it represents -networks: Network specific information by network (address, id, constructor args, etc...) -compilerOutput: The Solidity compiler output generated from the specified compiler input -description (http://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description) -compiler: The compiler settings used -sourceCodes: The source code of the contract and all it's dependencies -sources: A mapping from source filePath to sourceMap id -sourceTreeHashHex: A unique hash generated from the contract source and that of it's dependencies. -If any of the sources change, the hash would change notifying us that a re-compilation is necessary - - -## Properties - -### compiler - -• **compiler**: *[CompilerOpts](#class-compileropts)* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* - -*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L641)* - -___ - -### compilerOutput - -• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* - -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L651)* - -___ - -### contractName - -• **contractName**: *string* - -*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L675)* - -___ - -### networks - -• **networks**: *[ContractNetworks](#class-contractnetworks)* - -*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L676)* - -___ - -### schemaVersion - -• **schemaVersion**: *string* - -*Defined in [ethereum-types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L674)* - -___ - -### sourceCodes - -• **sourceCodes**: *object* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* - -*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L647)* - -#### Type declaration: - -● \[▪ **sourceName**: *string*\]: string - -___ - -### sourceTreeHashHex - -• **sourceTreeHashHex**: *string* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* - -*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L650)* - -___ - -### sources - -• **sources**: *object* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* - -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L642)* - -#### Type declaration: - -● \[▪ **sourceName**: *string*\]: object - -
- -# Interface: ContractNetworkData - - -## Properties - -### address - -• **address**: *string* - -*Defined in [ethereum-types/src/index.ts:554](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L554)* - -___ - -Args - -• **constructorArgs**: *string* - -*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L558)* - -___ - -### links - -• **links**: *object* - -*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L555)* - -#### Type declaration: - -● \[▪ **linkName**: *string*\]: string - -
- -# Interface: ContractNetworks - - -## Hierarchy - -* **ContractVersionData** - - * [ContractArtifact](#class-contractartifact) - - -## Properties - -### compiler - -• **compiler**: *[CompilerOpts](#class-compileropts)* - -*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L641)* - -___ - -### compilerOutput - -• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* - -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L651)* - -___ - -### sourceCodes - -• **sourceCodes**: *object* - -*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L647)* - -#### Type declaration: - -● \[▪ **sourceName**: *string*\]: string - -___ - -### sourceTreeHashHex - -• **sourceTreeHashHex**: *string* - -*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L650)* - -___ - -### sources - -• **sources**: *object* - -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L642)* - -#### Type declaration: - -● \[▪ **sourceName**: *string*\]: object - -
- -# Interface: DataItem - - -## Properties - -### `Optional` components - -• **components**? : *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)* - -___ - -### name - -• **name**: *string* - -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* - -
- -# Interface: DecodedLogArgs - - -## Type parameters - -▪ **A** - - -## Properties - -### address - -• **address**: *string* - -*Inherited from [LogEntry](#interface-logentry).[address](#address)* - -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* - -___ - -### args - -• **args**: *`A`* - -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* - -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* - -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* - -___ - -### data - -• **data**: *string* - -*Inherited from [LogEntry](#interface-logentry).[data](#data)* - -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* - -___ - -### event - -• **event**: *string* - -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* - -___ - -### topics - -• **topics**: *string[]* - -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* - -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* - -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* - -
- -# Interface: DecodedLogEntryEvent <**A**> - -## Type parameters - -▪ **A** - - -## Properties - -### address - -• **address**: *string* - -*Inherited from [LogEntry](#interface-logentry).[address](#address)* - -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* - -___ - -### args - -• **args**: *`A`* - -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* - -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* - -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* - -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* - -___ - -### data - -• **data**: *string* - -*Inherited from [LogEntry](#interface-logentry).[data](#data)* - -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* - -___ - -### event - -• **event**: *string* - -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* - -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* - -___ - -### removed - -• **removed**: *boolean* - -*Defined in [ethereum-types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L421)* - -___ - -### topics - -• **topics**: *string[]* - -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* - -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* - -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* - -
- -# Interface: DevdocOutput - - -## Properties - -### `Optional` author - -• **author**? : *undefined | string* - -*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L628)* - -___ - -### methods - -• **methods**: *object* - -*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L629)* - -#### Type declaration: - -● \[▪ **signature**: *string*\]: object - -___ - -### `Optional` title - -• **title**? : *undefined | string* - -*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L627)* - -
- -# Interface: EIP1193Provider - - -## Properties - -### isEIP1193 - -• **isEIP1193**: *boolean* - -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)* - -## Methods - -### on - -▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* - -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)* - -**Parameters:** - -▪ **event**: *[EIP1193Event](#eip1193event)* - -▪ **listener**: *function* - -▸ (`result`: any): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`result` | any | - -**Returns:** *this* - -___ - -### send - -▸ **send**(`method`: string, `params?`: any[]): *`Promise`* - -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)* - -**Parameters:** - -Name | Type | ------- | ------ | -`method` | string | -`params?` | any[] | - -**Returns:** *`Promise`* - -
- - - - - -# Interface: EvmBytecodeOutput - - -## Properties - -### object - -• **object**: *string* - -*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L622)* - -___ - -### sourceMap - -• **sourceMap**: *string* - -*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L623)* - -
- -# Interface: EvmOutput - - -## Properties - -### bytecode - -• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* - -*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L617)* - -___ - -### deployedBytecode - -• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* - -*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L618)* - -
- -# Interface: FallbackAbi - - -## Properties - -### payable - -• **payable**: *boolean* - -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L112)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L111)* - -
- - - -# Interface: GanacheProvider - - -## Methods - -### sendAsync - -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* - -*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L14)* - -**Parameters:** - -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | - -**Returns:** *void* - -
- - - -# Interface: JSONRPCRequestPayload - - -## Properties - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* - -___ - -### method - -• **method**: *string* - -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* - -___ - -### params - -• **params**: *any[]* - -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* - -
- -# Interface: JSONRPCResponseError - - -## Properties - -### code - -• **code**: *number* - -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* - -___ - -### message - -• **message**: *string* - -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* - -
- -# Interface: JSONRPCResponsePayload - - -## Properties - -### `Optional` error - -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* - -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* - -___ - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* - -___ - -### result - -• **result**: *any* - -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* - -
- -# Interface: LogEntry - - -## Properties - -### address - -• **address**: *string* - -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* - -___ - -### data - -• **data**: *string* - -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* - -___ - -### topics - -• **topics**: *string[]* - -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* - -
- -# Interface: LogEntryEvent - - -## Properties - -### address - -• **address**: *string* - -*Inherited from [LogEntry](#interface-logentry).[address](#address)* - -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* - -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* - -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* - -___ - -### data - -• **data**: *string* - -*Inherited from [LogEntry](#interface-logentry).[data](#data)* - -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* - -___ - -### removed - -• **removed**: *boolean* - -*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L425)* - -___ - -### topics - -• **topics**: *string[]* - -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* - -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* - -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* - -
- -# Interface: LogWithDecodedArgs <**ArgsType**> - -## Type parameters - -▪ **ArgsType**: *[DecodedLogArgs](#class-decodedlogargs)* - - -## Properties - -### address - -• **address**: *string* - -*Inherited from [LogEntry](#interface-logentry).[address](#address)* - -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* - -___ - -### args - -• **args**: *`ArgsType`* - -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* - -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* - -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* - -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* - -___ - -### data - -• **data**: *string* - -*Inherited from [LogEntry](#interface-logentry).[data](#data)* - -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* - -___ - -### event - -• **event**: *string* - -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* - -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* - -___ - -### topics - -• **topics**: *string[]* - -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* - -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* - -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* - -
- -# Interface: MethodAbi - - -## Properties - -### constant - -• **constant**: *boolean* - -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L94)* - -___ - -### inputs - -• **inputs**: *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L92)* - -___ - -### name - -• **name**: *string* - -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L91)* - -___ - -### outputs - -• **outputs**: *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L93)* - -___ - -### payable - -• **payable**: *boolean* - -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L96)* - -___ - -### stateMutability - -• **stateMutability**: *[StateMutability](#statemutability)* - -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L95)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L90)* - -
- -# Interface: OptimizerSettings - - -## Properties - -### enabled - -• **enabled**: *boolean* - -*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L708)* - -___ - -### `Optional` runs - -• **runs**? : *undefined | number* - -*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L709)* - -
- # Class: CoordinatorContract @@ -20520,7 +9,7 @@ ___ *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1112](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1112)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1489](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1489)* **Parameters:** @@ -20574,13 +63,39 @@ ___ Defined in base-contract/lib/src/index.d.ts:29 +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string | undefined* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L31)* + ## Methods +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:818](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L818)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1195](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1195)* **Returns:** *[ContractAbi](#contractabi)* @@ -20592,7 +107,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:771](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L771)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1148)* **Parameters:** @@ -20613,7 +128,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:738](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L738)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1115](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1115)* **Parameters:** @@ -20652,13 +167,13 @@ Name | Type | #### ▪ **EIP712_COORDINATOR_DOMAIN_HASH**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:695](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L695)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1037](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1037)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:701](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L701)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1043](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1043)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -20673,19 +188,69 @@ Name | Type | Default | **Returns:** *`Promise`* +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1107](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1107)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1095](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1095)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1085](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1085)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### EIP712_EXCHANGE_DOMAIN_HASH #### ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:498](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L498)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:667](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L667)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:504](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L504)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:673](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.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 @@ -20700,13 +265,63 @@ Name | Type | Default | **Returns:** *`Promise`* +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:737](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L737)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:725](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L725)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:715](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L715)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### assertValidCoordinatorApprovals #### ▪ **assertValidCoordinatorApprovals**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:545](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L545)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:749](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L749)* Validates that the 0x transaction has been approved by all of the feeRecipients that correspond to each order in the transaction's Exchange calldata. @@ -20715,7 +330,7 @@ that correspond to each order in the transaction's Exchange calldata. ▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:560](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L560)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:764](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L764)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -20735,13 +350,73 @@ Name | Type | Default | Description | **Returns:** *`Promise`* +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:885](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L885)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string, string, `BigNumber`[], string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:867](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L867)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[object, string, string, `BigNumber`[], string[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:838](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L838)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | Proof that the transaction has been signed by the signer. | +`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### decodeOrdersFromFillData #### ▪ **decodeOrdersFromFillData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:623](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L623)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:898](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L898)* Decodes the orders from Exchange calldata representing any fill method. @@ -20749,7 +424,7 @@ Decodes the orders from Exchange calldata representing any fill method. ▸ **callAsync**(`data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:631](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L631)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:906](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L906)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -20767,36 +442,93 @@ Name | Type | Default | Description | The orders from the Exchange calldata. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:999](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L999)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`Array`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:987](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L987)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`data`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:976](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L976)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`data` | string | Exchange calldata representing a fill method. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### executeTransaction #### ▪ **executeTransaction**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:206](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L206)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:339](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L339)* 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`* +▸ **awaitTransactionSuccessAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:288](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L288)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:409](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L409)* 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 } | - | +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | Proof that the transaction has been signed by the signer. | +`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* @@ -20806,7 +538,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L389)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:536](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L536)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -20830,7 +562,7 @@ Name | Type | Default | Description | ▸ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L337)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:458](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L458)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. @@ -20849,11 +581,47 @@ Name | Type | Description | The hash of the transaction +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:657](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L657)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string, string, `BigNumber`[], string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:639](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L639)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[object, string, string, `BigNumber`[], string[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:463](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L463)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:610](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L610)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used @@ -20873,48 +641,56 @@ Name | Type | Description | The ABI encoded transaction data as a string -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:490](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L490)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - #### sendTransactionAsync -▸ **sendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +▸ **sendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:222](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L222)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L355)* 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 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 } | - | +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | Proof that the transaction has been signed by the signer. | +`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | +`txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:496](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L496)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transaction` | object | +`txOrigin` | string | +`transactionSignature` | string | +`approvalExpirationTimeSeconds` | `BigNumber`[] | +`approvalSignatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + ___ ### getCoordinatorApprovalHash #### ▪ **getCoordinatorApprovalHash**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:145](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L145)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:221](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L221)* Calculated the EIP712 hash of the Coordinator approval mesasage using the domain separator of this contract. @@ -20922,7 +698,7 @@ Calculated the EIP712 hash of the Coordinator approval mesasage using the domain ▸ **callAsync**(`approval`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:154](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L154)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:230](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L230)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -20940,13 +716,69 @@ Name | Type | Default | Description | EIP712 hash of the Coordinator approval message with the domain separator of this contract. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L328)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:304](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L304)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`approval`: object): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:286](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L286)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`approval` | object | Coordinator approval message containing the transaction hash, transaction signature, and expiration of the approval. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getSignerAddress #### ▪ **getSignerAddress**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L44)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L35)* Recovers the address of a signer given a hash and signature. @@ -20954,7 +786,7 @@ Recovers the address of a signer given a hash and signature. ▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L52)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L43)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -20971,13 +803,70 @@ Name | Type | Default | Description | **Returns:** *`Promise`* +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:113](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L113)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:101](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L101)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:86](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L86)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32 byte hash. | +`signature` | string | Proof that the hash has been signed by signer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + ___ ### getTransactionHash #### ▪ **getTransactionHash**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L91)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:124](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L124)* Calculates the EIP712 hash of a 0x transaction using the domain separator of the Exchange contract. @@ -20985,7 +874,7 @@ Calculates the EIP712 hash of a 0x transaction using the domain separator of the ▸ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L99)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:132](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L132)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas @@ -21003,8 +892,30305 @@ Name | Type | Default | Description | EIP712 hash of the transaction with the domain separator of this contract. +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:210](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L210)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L194)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transaction`: object): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L181)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction containing salt, signerAddress, and data. | + +**Returns:** *string* + +The ABI encoded transaction data as a string +
+# Class: CoordinatorRegistryContract + + +## Constructors + + + +\+ **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_registry.ts:520](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L520)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | CoordinatorRegistryContract.deployedBytecode | + +**Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string | undefined* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L43)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:504](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L504)* + +Gets historical logs without creating a subscription + +**Type parameters:** + +▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | The CoordinatorRegistry contract event you would like to subscribe to. | +`blockRange` | `BlockRange` | Block range to get logs from. | +`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | + +**Returns:** *`Promise>>`* + +Array of logs that match the parameters + +___ + +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:462](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L462)* + +Subscribe to an event type emitted by the CoordinatorRegistry contract. + +**Type parameters:** + +▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | - | The CoordinatorRegistry contract event you would like to subscribe to. | +`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | +`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | +`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | +`blockPollingIntervalMs?` | undefined \| number | - | - | + +**Returns:** *string* + +Subscription token used later to unsubscribe + +___ + +### unsubscribe + +▸ **unsubscribe**(`subscriptionToken`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:487](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L487)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:493](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L493)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L390)* + +**Returns:** *[ContractAbi](#contractabi)* + +The contract ABI + +___ + +### `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:348](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L348)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + +### `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:317](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L317)* + +**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 + +### getCoordinatorEndpoint + +#### ▪ **getCoordinatorEndpoint**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:226](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L226)* + +Gets the endpoint for a Coordinator. + +#### callAsync + +▸ **callAsync**(`coordinatorOperator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:233](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L233)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`coordinatorOperator` | string | - | operator of the Coordinator endpoint. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:308](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L308)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:296](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L296)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`coordinatorOperator`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:283](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L283)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`coordinatorOperator` | string | operator of the Coordinator endpoint. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### setCoordinatorEndpoint + +#### ▪ **setCoordinatorEndpoint**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L47)* + +Called by a Coordinator operator to set the endpoint of their Coordinator. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L82)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`coordinatorEndpoint` | string | endpoint of the Coordinator. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`coordinatorEndpoint`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:142](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.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 | +------ | ------ | ------ | ------ | +`coordinatorEndpoint` | string | - | endpoint of the Coordinator. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:109](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L109)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`coordinatorEndpoint` | string | endpoint of the Coordinator. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L215)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:203](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L203)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`coordinatorEndpoint`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:190](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L190)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`coordinatorEndpoint` | string | endpoint of the Coordinator. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L55)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`coordinatorEndpoint` | string | endpoint of the Coordinator. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L128)* + +**Parameters:** + +Name | Type | +------ | ------ | +`coordinatorEndpoint` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: DevUtilsContract + + +## Constructors + + + +\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DevUtilsContract](#class-devutilscontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:5507](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L5507)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | DevUtilsContract.deployedBytecode | + +**Returns:** *[DevUtilsContract](#class-devutilscontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b506004361061025c5760003560e01c80639a7e752611610145578063cafd3a07116100bd578063d3d862d11161008c578063e4e6e7da11610071578063e4e6e7da1461063a578063e77286eb1461065b578063ee4f5a941461067d5761025c565b8063d3d862d114610605578063e25cabf7146106185761025c565b8063cafd3a071461059e578063d001c5dc146105bf578063d186037f146105d2578063d3637905146105e55761025c565b8063a6627e9f11610114578063b43cffe1116100f9578063b43cffe114610548578063bbb2dcf61461055b578063bc03f9641461057d5761025c565b8063a6627e9f14610512578063acaedc74146105255761025c565b80639a7e7526146104985780639eadc835146104bb578063a0901e51146104df578063a5cd62ba146104f25761025c565b8063459be5e2116101d85780636f83188e116101a75780637b66ad341161018c5780637b66ad34146104515780637d727512146104725780638f4ce479146104855761025c565b80636f83188e1461040d5780637914b2ec146104305761025c565b8063459be5e21461038a5780634dfdac20146103ab578063590aa875146103cb57806365129042146103eb5761025c565b80632322cf761161022f578063327d305411610214578063327d30541461033257806332aae3ad146103455780633db6dc61146103675761025c565b80632322cf76146102f0578063314853ff146103105761025c565b806302d0aec31461026157806304a5618a1461028b5780630d7b7d76146102ad578063165979e1146102ce575b600080fd5b61027461026f3660046149dd565b61069f565b6040516102829291906152e4565b60405180910390f35b61029e6102993660046149dd565b6106fb565b60405161028293929190615387565b6102c06102bb366004614565565b6107a9565b604051610282929190615292565b6102e16102dc3660046149dd565b6107cb565b604051610282939291906154c2565b6103036102fe366004614565565b610828565b6040516102829190615731565b61032361031e3660046149dd565b610850565b604051610282939291906152b9565b6102c06103403660046149dd565b610897565b6103586103533660046149dd565b6108d9565b60405161028293929190615438565b61037a6103753660046149dd565b61092c565b6040516102829493929190615258565b61039d6103983660046149dd565b610976565b6040516102829291906154ab565b6103be6103b936600461448c565b6109cc565b60405161028291906151f2565b6103de6103d936600461435d565b610a4f565b60405161028291906153e7565b6103fe6103f93660046149dd565b610ad3565b60405161028293929190614fdf565b61042061041b3660046149dd565b610b0d565b6040516102829493929190615535565b61044361043e3660046149dd565b61164e565b604051610282929190615301565b61046461045f3660046149dd565b611686565b604051610282929190614fc5565b610303610480366004614565565b6116be565b6104436104933660046149dd565b611dd3565b6104ab6104a63660046149dd565b611e63565b60405161028294939291906154f1565b6104ce6104c93660046149dd565b611ec4565b604051610282959493929190615324565b6103be6104ed3660046145d4565b611f6f565b61050561050036600461463a565b611fe8565b60405161028291906150f9565b6103de6105203660046145a9565b6120ac565b6105386105333660046149dd565b612133565b6040516102829493929190615055565b6103de6105563660046144da565b61216f565b61056e6105693660046149dd565b6121fc565b604051610282939291906153b2565b61059061058b3660046149dd565b6122a9565b6040516102829291906152a0565b6105b16105ac3660046149dd565b6122e2565b604051610282929190615528565b6103be6105cd36600461448c565b612330565b6103036105e0366004614565565b61239e565b6105f86105f3366004614a94565b6129e1565b60405161028291906154dd565b6103de6106133660046147e2565b612f7e565b61062b6106263660046146be565b612fb6565b60405161028293929190615146565b61064d61064836600461448c565b6130ee565b604051610282929190615233565b61066e610669366004614aec565b613107565b604051610282939291906156d5565b61069061068b3660046149dd565b613341565b60405161028293929190615481565b6000806106b3836106ae61337e565b6133a2565b60006106cc60048551866133fc9092919063ffffffff16565b8060200190516106df9190810190614990565b909350905060ff811660068111156106f357fe5b915050915091565b6000808061070f848263ffffffff61343f16565b92506001600160e01b031983167f02571792000000000000000000000000000000000000000000000000000000001461077d576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107749061569e565b60405180910390fd5b61078e84601063ffffffff61347316565b91506107a184602463ffffffff6134a616565b929491935050565b6000806107b684846116be565b91506107c2848461239e565b90509250929050565b60008060006107dc846106ae6134b2565b60006107f560048651876133fc9092919063ffffffff16565b8060200190516108089190810190614d20565b9094509250905060ff8116600281111561081e57fe5b9350509193909250565b600080600061083785856107a9565b9150915061084582826134d6565b925050505b92915050565b6000606080610861846106ae6134ec565b835161087790859060049063ffffffff6133fc16565b80602001905161088a9190810190614930565b9196909550909350915050565b6000806108a6836106ae613510565b82516108bc90849060049063ffffffff6133fc16565b8060200190516108cf91908101906148d2565b9094909350915050565b60008060606108ea846106ae613534565b600061090360048651876133fc9092919063ffffffff16565b8060200190516109169190810190614cd4565b9094509250905060ff8116600181111561081e57fe5b60008060608061093e856106ae613558565b845161095490869060049063ffffffff6133fc16565b806020019051610967919081019061488e565b92989197509550909350915050565b600080610985836106ae61357c565b600061099e60048551866133fc9092919063ffffffff16565b8060200190516109b19190810190614c07565b9250905060ff811660038111156109c457fe5b925050915091565b6060600082519050806040519080825280602002602001820160405280156109fe578160200160208202803883390190505b50915060005b818114610a4757610a2885858381518110610a1b57fe5b602002602001015161239e565b838281518110610a3457fe5b6020908102919091010152600101610a04565b505092915050565b6040516060907ff47261b00000000000000000000000000000000000000000000000000000000090610a85908490602401614fb1565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b0319909316929092179091529050919050565b6000806000610ae4846106ae6135a0565b8351610afa90859060049063ffffffff6133fc16565b80602001905161088a91908101906143b2565b60608080806000610b24868263ffffffff61343f16565b90506001600160e01b031981167fdedfc1f1000000000000000000000000000000000000000000000000000000001415610b95576040518060400160405280601181526020017f626174636843616e63656c4f72646572730000000000000000000000000000008152509450611124565b6001600160e01b031981167f9694a402000000000000000000000000000000000000000000000000000000001415610c04576040518060400160405280600f81526020017f626174636846696c6c4f726465727300000000000000000000000000000000008152509450611124565b6001600160e01b031981167f8ea8dfe4000000000000000000000000000000000000000000000000000000001415610c73576040518060400160405280601681526020017f626174636846696c6c4f72646572734e6f5468726f77000000000000000000008152509450611124565b6001600160e01b031981167fbeee2e14000000000000000000000000000000000000000000000000000000001415610ce2576040518060400160405280601581526020017f626174636846696c6c4f724b696c6c4f726465727300000000000000000000008152509450611124565b6001600160e01b031981167f2da62987000000000000000000000000000000000000000000000000000000001415610d51576040518060400160405280600b81526020017f63616e63656c4f726465720000000000000000000000000000000000000000008152509450611124565b6001600160e01b031981167f9b44d556000000000000000000000000000000000000000000000000000000001415610dc0576040518060400160405280600981526020017f66696c6c4f7264657200000000000000000000000000000000000000000000008152509450611124565b6001600160e01b031981167fe14b58c4000000000000000000000000000000000000000000000000000000001415610e2f576040518060400160405280600f81526020017f66696c6c4f724b696c6c4f7264657200000000000000000000000000000000008152509450611124565b6001600160e01b031981167f78d29ac1000000000000000000000000000000000000000000000000000000001415610e9e576040518060400160405280601681526020017f6d61726b65744275794f72646572734e6f5468726f77000000000000000000008152509450611124565b6001600160e01b031981167f369da099000000000000000000000000000000000000000000000000000000001415610f0d576040518060400160405280601781526020017f6d61726b657453656c6c4f72646572734e6f5468726f770000000000000000008152509450611124565b6001600160e01b031981167f8bc8efb3000000000000000000000000000000000000000000000000000000001415610f7c576040518060400160405280601981526020017f6d61726b65744275794f726465727346696c6c4f724b696c6c000000000000008152509450611124565b6001600160e01b031981167fa6c3bf33000000000000000000000000000000000000000000000000000000001415610feb576040518060400160405280601a81526020017f6d61726b657453656c6c4f726465727346696c6c4f724b696c6c0000000000008152509450611124565b6001600160e01b031981167f88ec79fb00000000000000000000000000000000000000000000000000000000141561105a576040518060400160405280600b81526020017f6d617463684f72646572730000000000000000000000000000000000000000008152509450611124565b6001600160e01b031981167f4f9559b10000000000000000000000000000000000000000000000000000000014806110bb57506001600160e01b031981167f2280c91000000000000000000000000000000000000000000000000000000000145b156110f2576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161077490615630565b6040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610774906155f9565b6001600160e01b031981167fdedfc1f10000000000000000000000000000000000000000000000000000000014156111c957855161116c90879060049063ffffffff6135c416565b80602001905161117f9190810190614607565b604080516000808252602082019092529195505b50604080516000808252602082019092529194506111c1565b60608152602001906001900390816111ac5790505b509150611646565b6001600160e01b031981167fbeee2e1400000000000000000000000000000000000000000000000000000000148061122a57506001600160e01b031981167f9694a40200000000000000000000000000000000000000000000000000000000145b8061125e57506001600160e01b031981167f8ea8dfe400000000000000000000000000000000000000000000000000000000145b156112785761126c86613644565b91955093509150611646565b6001600160e01b031981167f2da629870000000000000000000000000000000000000000000000000000000014156113605760408051600180825281830190925290816020015b6112c7613c90565b8152602001906001900390816112bf57505086519094506112f290879060049063ffffffff6135c416565b8060200190516113059190810190614a61565b8460008151811061131257fe5b602002602001018190525060006040519080825280602002602001820160405280156111935781602001602082028038833901905050604080516000808252602082019092529194506111c1565b6001600160e01b031981167fe14b58c40000000000000000000000000000000000000000000000000000000014806113c157506001600160e01b031981167f9b44d55600000000000000000000000000000000000000000000000000000000145b156113cf5761126c86613673565b6001600160e01b031981167f78d29ac100000000000000000000000000000000000000000000000000000000148061143057506001600160e01b031981167f369da09900000000000000000000000000000000000000000000000000000000145b8061146457506001600160e01b031981167f8bc8efb300000000000000000000000000000000000000000000000000000000145b8061149857506001600160e01b031981167fa6c3bf3300000000000000000000000000000000000000000000000000000000145b156114a65761126c8661376d565b6001600160e01b031981167f88ec79fb000000000000000000000000000000000000000000000000000000001415611646576114e0613c90565b6114e8613c90565b60608061150260048b518c6135c49092919063ffffffff16565b8060200190516115159190810190614b43565b604080516002808252606082019092529498509296509094509250816020015b61153d613c90565b815260200190600190039081611535579050509750838860008151811061156057fe5b6020026020010181905250828860018151811061157957fe5b602090810291909101015260408051600280825260608201909252908160200160208202803883390190505096508360a00151876000815181106115b957fe5b6020026020010181815250508260a00151876001815181106115d757fe5b60209081029190910101526040805160028082526060820190925290816020015b60608152602001906001900390816115f8579050509550818660008151811061161d57fe5b6020026020010181905250808660018151811061163657fe5b6020026020010181905250505050505b509193509193565b60008061165d836106ae6137e1565b825161167390849060049063ffffffff6133fc16565b8060200190516108cf91908101906149b4565b600080611695836106ae613805565b82516116ab90849060049063ffffffff6133fc16565b8060200190516108cf9190810190614379565b6000806116d1838263ffffffff61343f16565b90506001600160e01b031981167ff47261b000000000000000000000000000000000000000000000000000000000141561184657600061171884601063ffffffff61347316565b6040519091506060907f70a082310000000000000000000000000000000000000000000000000000000090611751908890602401614fb1565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060836001600160a01b0316836040516117cc9190614f95565b600060405180830381855afa9150503d8060008114611807576040519150601f19603f3d011682016040523d82523d6000602084013e61180c565b606091505b509150915081801561181f575080516020145b61182a57600061183b565b61183b81600063ffffffff6134a616565b955050505050611dcc565b6001600160e01b031981167f025717920000000000000000000000000000000000000000000000000000000014156119e157600080611884856106fb565b6040519194509250606091507f6352211e00000000000000000000000000000000000000000000000000000000906118c0908490602401615731565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060846001600160a01b03168360405161193b9190614f95565b600060405180830381855afa9150503d8060008114611976576040519150601f19603f3d011682016040523d82523d6000602084013e61197b565b606091505b50915091506000828015611990575081516020145b61199b5760006119ac565b6119ac82600c63ffffffff61347316565b9050896001600160a01b0316816001600160a01b0316146119ce5760006119d1565b60015b60ff169750505050505050611dcc565b6001600160e01b031981167fa7cb5fb7000000000000000000000000000000000000000000000000000000001415611bc4576000606080611a2186611ec4565b5081519296509094509250905060005b818114611bba5783516060907efdd58e00000000000000000000000000000000000000000000000000000000908b90879085908110611a6c57fe5b6020026020010151604051602401611a85929190615089565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060876001600160a01b031683604051611b009190614f95565b600060405180830381855afa9150503d8060008114611b3b576040519150601f19603f3d011682016040523d82523d6000602084013e611b40565b606091505b50915091506000828015611b55575081516020145b611b60576000611b71565b611b7182600063ffffffff6134a616565b90506000878681518110611b8157fe5b60200260200101518281611b9157fe5b0490508b811080611ba057508b155b15611ba957809b505b505060019093019250611a31915050565b5050505050611dcc565b6001600160e01b031981167fc339d10a000000000000000000000000000000000000000000000000000000001415611d15576040516060907fa85e59e40000000000000000000000000000000000000000000000000000000090611c33908690600090819081906024016153fa565b60408051601f198184030181529181526020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b03199094169390931790925260045491519092506000916001600160a01b031690611c9a908490614f95565b600060405180830381855afa9150503d8060008114611cd5576040519150601f19603f3d011682016040523d82523d6000602084013e611cda565b606091505b5050905080611cea576000611d0c565b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff5b93505050611dcc565b6001600160e01b031981167f94cfcdd7000000000000000000000000000000000000000000000000000000001415611dcc57606080611d53856121fc565b80519194509250905060005b818114611dc7576000611d8589858481518110611d7857fe5b60200260200101516116be565b90506000858381518110611d9557fe5b60200260200101518281611da557fe5b04905087811080611db4575087155b15611dbd578097505b5050600101611d5f565b505050505b5092915050565b600080611de6838263ffffffff61343f16565b91506001600160e01b031982167ff47261b00000000000000000000000000000000000000000000000000000000014611e4b576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107749061569e565b611e5c83601063ffffffff61347316565b9050915091565b60008060006060611e76856106ae613829565b6000611e8f60048751886133fc9092919063ffffffff16565b806020019051611ea29190810190614c76565b91965094509250905060ff81166006811115611eba57fe5b9450509193509193565b60008060608080611edb868563ffffffff61343f16565b94506001600160e01b031985167fa7cb5fb70000000000000000000000000000000000000000000000000000000014611f40576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107749061569e565b505050506024828101516044840151606485015160848601519496929591820184019490820184019391010190565b6060808251604051908082528060200260200182016040528015611f9d578160200160208202803883390190505b50905060005b83518114611dcc57838181518110611fb757fe5b60200260200101516001600160a01b031631828281518110611fd557fe5b6020908102919091010152600101611fa3565b60606000845190508060405190808252806020026020018201604052801561201a578160200160208202803883390190505b50915060005b8181146120a25761206b86828151811061203657fe5b602002602001015186838151811061204a57fe5b602002602001015186848151811061205e57fe5b60200260200101516129e1565b83828151811061207757fe5b6020026020010190600481111561208a57fe5b9081600481111561209757fe5b905250600101612020565b50505b9392505050565b6040516060907f0257179200000000000000000000000000000000000000000000000000000000906120e49085908590602401615089565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b031990931692909217909152905092915050565b60006060806060612146856106ae61384d565b845161215c90869060049063ffffffff6133fc16565b80602001905161096791908101906143f4565b6040516060907fa7cb5fb700000000000000000000000000000000000000000000000000000000906121ab908790879087908790602401615003565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b0319909316929092179091529050949350505050565b6000606080612211848463ffffffff61343f16565b92506001600160e01b031983167f94cfcdd70000000000000000000000000000000000000000000000000000000014612276576040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016107749061569e565b835161228c90859060049063ffffffff6135c416565b80602001905161229f9190810190614817565b9395909450915050565b600060606122b9836106ae613871565b82516122cf90849060049063ffffffff6133fc16565b8060200190516108cf91908101906148f5565b6000806122f1836106ae613895565b600061230a60048551866133fc9092919063ffffffff16565b80602001905161231d9190810190614c07565b9250905060ff811660018111156109c457fe5b606060008251905080604051908082528060200260200182016040528015612362578160200160208202803883390190505b50915060005b818114610a475761237f85858381518110611d7857fe5b83828151811061238b57fe5b6020908102919091010152600101612368565b6000806123b1838263ffffffff61343f16565b90506001600160e01b031981167f94cfcdd7000000000000000000000000000000000000000000000000000000001415612463576060806123f1856121fc565b80519194509250905060005b81811461245857600061241689858481518110610a1b57fe5b9050600085838151811061242657fe5b6020026020010151828161243657fe5b04905087811080612445575087155b1561244e578097505b50506001016123fd565b5061084a9350505050565b6001600160e01b031981167ff47261b00000000000000000000000000000000000000000000000000000000014156124ee5760006124a884601063ffffffff61347316565b6001546040519192506060917fdd62ed3e00000000000000000000000000000000000000000000000000000000916117519189916001600160a01b031690602401614fc5565b6001600160e01b031981167f025717920000000000000000000000000000000000000000000000000000000014156127de5760008061252c856106fb565b600254604051929550909350606092507fe985e9c50000000000000000000000000000000000000000000000000000000091612578918a916001600160a01b0390911690602401614fc5565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060846001600160a01b0316836040516125f39190614f95565b600060405180830381855afa9150503d806000811461262e576040519150601f19603f3d011682016040523d82523d6000602084013e612633565b606091505b509150915081158061264757508051602014155b80612663575061265e81600063ffffffff6134a616565b600114155b156127b1576040516060907f081812fc000000000000000000000000000000000000000000000000000000009061269e908790602401615731565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050509050856001600160a01b0316816040516127159190614f95565b600060405180830381855afa9150503d8060008114612750576040519150601f19603f3d011682016040523d82523d6000602084013e612755565b606091505b509093509150828015612769575081516020145b801561279857506002546001600160a01b031661278d83600c63ffffffff61347316565b6001600160a01b0316145b6127a35760006127a6565b60015b60ff16975050611bba565b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff96505050505050611dcc565b6001600160e01b031981167fa7cb5fb700000000000000000000000000000000000000000000000000000000141561298657600061281b84611ec4565b5050600354604051929450606093507fe985e9c50000000000000000000000000000000000000000000000000000000092612865925089916001600160a01b031690602401614fc5565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff8381831617835250505050905060006060836001600160a01b0316836040516128e09190614f95565b600060405180830381855afa9150503d806000811461291b576040519150601f19603f3d011682016040523d82523d6000602084013e612920565b606091505b5091509150818015612933575080516020145b801561294f575061294b81600063ffffffff6134a616565b6001145b61295a57600061183b565b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff955050505050611dcc565b6001600160e01b031981167fc339d10a000000000000000000000000000000000000000000000000000000001415611dcc57507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff9392505050565b60006129eb613d23565b612a7c8584600560009054906101000a90046001600160a01b03166001600160a01b0316631ce4c78b6040518163ffffffff1660e01b815260040160206040518083038186803b158015612a3e57600080fd5b505afa158015612a52573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250612a769190810190614bef565b3a6138b9565b60408051600480825260a0820190925291925060609190816020015b6060815260200190600190039081612a9857505060408051600480825260a082019092529192506060919060208201608080388339505060408051600480825260a08201909252929350606092915060208201608080388339505060408051600480825260a0820190925292935060609291506020820160808038833901905050905088610160015184600081518110612b2e57fe5b60200260200101819052508783600081518110612b4757fe5b60200260200101906001600160a01b031690816001600160a01b031681525050886000015182600081518110612b7957fe5b60200260200101906001600160a01b031690816001600160a01b0316815250508681600081518110612ba757fe5b60200260200101818152505088610140015184600181518110612bc657fe5b6020026020010181905250886000015183600181518110612be357fe5b60200260200101906001600160a01b031690816001600160a01b0316815250508782600181518110612c1157fe5b60200260200101906001600160a01b031690816001600160a01b031681525050846000015181600181518110612c4357fe5b602002602001018181525050886101a0015184600281518110612c6257fe5b60200260200101819052508783600281518110612c7b57fe5b60200260200101906001600160a01b031690816001600160a01b031681525050886040015182600281518110612cad57fe5b60200260200101906001600160a01b031690816001600160a01b031681525050846060015181600281518110612cdf57fe5b60200260200101818152505088610180015184600381518110612cfe57fe5b6020026020010181905250886000015183600381518110612d1b57fe5b60200260200101906001600160a01b031690816001600160a01b031681525050886040015182600381518110612d4d57fe5b60200260200101906001600160a01b031690816001600160a01b031681525050846040015181600381518110612d7f57fe5b60209081029190910101526040516060907fb04fbddd0000000000000000000000000000000000000000000000000000000090612dc69087908790879087906024016150a2565b60408051601f198184030181529181526020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b03199094169390931790925260055491519092506060916001600160a01b031690612e2d908490614f95565b6000604051808303816000865af19150503d8060008114612e6a576040519150601f19603f3d011682016040523d82523d6000602084013e612e6f565b606091505b50915060009050612e86828263ffffffff61343f16565b9050612e90613534565b6001600160e01b031982811691161415612ed2576000612eaf836108d9565b5091505060ff81166004811115612ec257fe5b99505050505050505050506120a5565b612eda6134ec565b6001600160e01b031982811691161415612f0d576000612ef983610850565b509091505060ff81166004811115612ec257fe5b815160208301207ff43f26ea5a94b478394a975e856464913dc1a8a1ca70939d974aa7c238aa0ce01415612f4c576004985050505050505050506120a5565b6040517f08c379a0000000000000000000000000000000000000000000000000000000008152600401610774906155c2565b6040516060907f94cfcdd700000000000000000000000000000000000000000000000000000000906120e49085908590602401615205565b606080606060008551905080604051908082528060200260200182016040528015612ffb57816020015b612fe8613d52565b815260200190600190039081612fe05790505b50935080604051908082528060200260200182016040528015613028578160200160208202803883390190505b50925080604051908082528060200260200182016040528015613055578160200160208202803883390190505b50915060005b8181146130e55761309287828151811061307157fe5b602002602001015187838151811061308557fe5b6020026020010151613107565b87518890859081106130a057fe5b602002602001018785815181106130b357fe5b602002602001018786815181106130c657fe5b931515602094850291909101909301929092529190525260010161305b565b50509250925092565b6060806130fb8484612330565b91506107c284846109cc565b61310f613d52565b600080546040517f9d3fa4b900000000000000000000000000000000000000000000000000000000815282916001600160a01b031690639d3fa4b9906131599088906004016156f9565b60606040518083038186803b15801561317157600080fd5b505afa158015613185573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052506131a99190810190614a10565b85516000546040517fa12dcc6f00000000000000000000000000000000000000000000000000000000815292955090916001600160a01b039091169063a12dcc6f906131fb908990899060040161570c565b60206040518083038186803b15801561321357600080fd5b505afa158015613227573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525061324b919081019061486e565b9150600061325e82886101400151610828565b60a088015160c08901516101808a01516101408b01519394509192909160009161328d9163ffffffff61393016565b156132ba576132b3846132ad848d6080015161395590919063ffffffff16565b85613971565b9050613313565b816132ce576132b3848b6080015185613971565b60006132df868c6101800151610828565b905060006132f2868d6080015187613971565b90506000613301838688613971565b905061330d82826134d6565b93505050505b61333361332d89604001518561399b90919063ffffffff16565b826134d6565b965050505050509250925092565b6000806000613352846106ae6139ba565b600061336b60048651876133fc9092919063ffffffff16565b8060200190516108089190810190614c34565b7ffdb6ca8d0000000000000000000000000000000000000000000000000000000090565b60006133af83600061343f565b90506001600160e01b0319808216908316146133f7576040517f08c379a000000000000000000000000000000000000000000000000000000000815260040161077490615667565b505050565b60608183111561341a5761341a613415600085856139de565b613a4d565b83518211156134335761343361341560018487516139de565b50819003910190815290565b600081600401835110156134605761346061341560038551856004016139de565b5001602001516001600160e01b03191690565b600081601401835110156134945761349461341560048551856014016139de565b5001601401516001600160a01b031690565b60006120a58383613a55565b7f18e4b1410000000000000000000000000000000000000000000000000000000090565b60008183106134e557816120a5565b5090919050565b7f4678472b0000000000000000000000000000000000000000000000000000000090565b7fb6555d6f0000000000000000000000000000000000000000000000000000000090565b7f488219a60000000000000000000000000000000000000000000000000000000090565b7f1b8388f70000000000000000000000000000000000000000000000000000000090565b7fe94a7ed00000000000000000000000000000000000000000000000000000000090565b7f4ad312750000000000000000000000000000000000000000000000000000000090565b6060818311156135dd576135dd613415600085856139de565b83518211156135f6576135f661341560018487516139de565b8282036040519080825280601f01601f191660200182016040528015613623576020820181803883390190505b5090506120a561363282613a7f565b8461363c87613a7f565b018351613a85565b606080606061366060048551866135c49092919063ffffffff16565b80602001905161088a9190810190614715565b60408051600180825281830190925260609182918291816020015b613696613c90565b81526020019060019003908161368e5750506040805160018082528183019092529194506020808301908038833901905050604080516001808252818301909252919350816020015b60608152602001906001900390816136df575050845190915061370c90859060049063ffffffff6135c416565b80602001905161371f9190810190614b9c565b8560008151811061372c57fe5b602002602001018560008151811061374057fe5b602002602001018560008151811061375457fe5b6020908102919091010192909252919052529193909250565b6040805160018082528183019092526060918291829160208083019080388339505085519193506137a99186915060049063ffffffff6135c416565b8060200190516137bc919081019061478f565b845185906000906137c957fe5b60209081029190910101919091529095929450925050565b7f11c7b7200000000000000000000000000000000000000000000000000000000090565b7fa15c0d060000000000000000000000000000000000000000000000000000000090565b7f7e5a23180000000000000000000000000000000000000000000000000000000090565b7f5bd0428d0000000000000000000000000000000000000000000000000000000090565b7f20d11f610000000000000000000000000000000000000000000000000000000090565b7ff59851840000000000000000000000000000000000000000000000000000000090565b6138c1613d23565b6020810184905260a085015160808601516138dd918691613b2a565b815260a085015160c08601516138f4918691613b2a565b604082015260a085015160e086015161390e918691613b2a565b6060820152613923828463ffffffff613b5e16565b6080820152949350505050565b6000815183511480156120a55750508051602091820120825192909101919091201490565b6000828201838110156120a5576120a561341560008686613b8b565b600061399383613987868563ffffffff613b5e16565b9063ffffffff613baa16565b949350505050565b6000828211156139b4576139b461341560028585613b8b565b50900390565b7fe53c76c80000000000000000000000000000000000000000000000000000000090565b6060632800659560e01b8484846040516024016139fd939291906154cf565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff166001600160e01b03199093169290921790915290509392505050565b805160208201fd5b60008160200183511015613a7657613a7661341560058551856020016139de565b50016020015190565b60200190565b6020811015613aaf576001816020036101000a0380198351168185511680821786525050506133f7565b82821415613abc576133f7565b82821115613af65760208103905080820181840181515b82851015613aee578451865260209586019590940193613ad3565b9052506133f7565b60208103905080820181840183515b81861215613b215782518252601f199283019290910190613b05565b85525050505050565b6000613b37848484613bd4565b15613b4a57613b4a613415858585613c3a565b61399383613987868563ffffffff613b5e16565b600082613b6d5750600061084a565b82820282848281613b7a57fe5b04146120a5576120a5613415600186865b606063e946c1bb60e01b8484846040516024016139fd93929190615460565b600081613bc057613bc061341560038585613b8b565b6000828481613bcb57fe5b04949350505050565b600082613be657613be6613415613c59565b811580613bf1575083155b15613bfe575060006120a5565b60008380613c0857fe5b8584099050613c1d858463ffffffff613b5e16565b613c2f826103e863ffffffff613b5e16565b101595945050505050565b606063339f3de260e01b8484846040516024016139fd9392919061573a565b60408051808201909152600481527fa791837c00000000000000000000000000000000000000000000000000000000602082015290565b604051806101c0016040528060006001600160a01b0316815260200160006001600160a01b0316815260200160006001600160a01b0316815260200160006001600160a01b03168152602001600081526020016000815260200160008152602001600081526020016000815260200160008152602001606081526020016060815260200160608152602001606081525090565b6040518060a0016040528060008152602001600081526020016000815260200160008152602001600081525090565b604080516060810182526000808252602082018190529181019190915290565b803561084a81615816565b805161084a81615816565b600082601f830112613d98578081fd5b8135613dab613da682615777565b615750565b818152915060208083019084810181840286018201871015613dcc57600080fd5b60005b84811015611dc7578135613de281615816565b84529282019290820190600101613dcf565b600082601f830112613e04578081fd5b8151613e12613da682615777565b8181529150602080830190840160005b83811015613e4f57613e3a8760208451890101614074565b83526020928301929190910190600101613e22565b5050505092915050565b600082601f830112613e69578081fd5b8135613e77613da682615777565b8181529150602080830190840160005b83811015613e4f57613e9f8760208435890101614026565b83526020928301929190910190600101613e87565b600082601f830112613ec4578081fd5b8151613ed2613da682615777565b8181529150602080830190840160005b83811015613e4f57613efa8760208451890101614209565b83526020928301929190910190600101613ee2565b600082601f830112613f1f578081fd5b8135613f2d613da682615777565b8181529150602080830190840160005b83811015613e4f57613f5587602084358901016140ba565b83526020928301929190910190600101613f3d565b600082601f830112613f7a578081fd5b8151613f88613da682615777565b818152915060208083019084810181840286018201871015613fa957600080fd5b60005b84811015611dc757815184529282019290820190600101613fac565b600082601f830112613fd8578081fd5b8135613fe6613da682615777565b81815291506020808301908481018184028601820187101561400757600080fd5b60005b84811015611dc75781358452928201929082019060010161400a565b600082601f830112614036578081fd5b8135614044613da682615797565b915080825283602082850101111561405b57600080fd5b8060208401602084013760009082016020015292915050565b600082601f830112614084578081fd5b8151614092613da682615797565b91508082528360208285010111156140a957600080fd5b611dcc8160208401602086016157bb565b60006101c08083850312156140cd578182fd5b6140d681615750565b9150506140e38383613d72565b81526140f28360208401613d72565b60208201526141048360408401613d72565b60408201526141168360608401613d72565b60608201526080820135608082015260a082013560a082015260c082013560c082015260e082013560e08201526101008083013581830152506101208083013581830152506101408083013567ffffffffffffffff8082111561417857600080fd5b61418486838701614026565b838501526101609250828501359150808211156141a057600080fd5b6141ac86838701614026565b838501526101809250828501359150808211156141c857600080fd5b6141d486838701614026565b838501526101a09250828501359150808211156141f057600080fd5b506141fd85828601614026565b82840152505092915050565b60006101c080838503121561421c578182fd5b61422581615750565b9150506142328383613d7d565b81526142418360208401613d7d565b60208201526142538360408401613d7d565b60408201526142658360608401613d7d565b60608201526080820151608082015260a082015160a082015260c082015160c082015260e082015160e08201526101008083015181830152506101208083015181830152506101408083015167ffffffffffffffff808211156142c757600080fd5b6142d386838701614074565b838501526101609250828501519150808211156142ef57600080fd5b6142fb86838701614074565b8385015261018092508285015191508082111561431757600080fd5b61432386838701614074565b838501526101a092508285015191508082111561433f57600080fd5b506141fd85828601614074565b805160ff8116811461084a57600080fd5b60006020828403121561436e578081fd5b81356120a581615816565b6000806040838503121561438b578081fd5b825161439681615816565b60208401519092506143a781615816565b809150509250929050565b6000806000606084860312156143c6578081fd5b83516143d181615816565b60208501519093506143e281615816565b80925050604084015190509250925092565b60008060008060808587031215614409578182fd5b845161441481615816565b602086015190945067ffffffffffffffff80821115614431578384fd5b61443d88838901614074565b94506040870151915080821115614452578384fd5b61445e88838901614074565b93506060870151915080821115614473578283fd5b5061448087828801614074565b91505092959194509250565b6000806040838503121561449e578182fd5b82356144a981615816565b9150602083013567ffffffffffffffff8111156144c4578182fd5b6144d085828601613e59565b9150509250929050565b600080600080608085870312156144ef578182fd5b84356144fa81615816565b9350602085013567ffffffffffffffff80821115614516578384fd5b61452288838901613fc8565b94506040870135915080821115614537578384fd5b61454388838901613fc8565b93506060870135915080821115614558578283fd5b5061448087828801614026565b60008060408385031215614577578182fd5b823561458281615816565b9150602083013567ffffffffffffffff81111561459d578182fd5b6144d085828601614026565b600080604083850312156145bb578182fd5b82356145c681615816565b946020939093013593505050565b6000602082840312156145e5578081fd5b813567ffffffffffffffff8111156145fb578182fd5b61399384828501613d88565b600060208284031215614618578081fd5b815167ffffffffffffffff81111561462e578182fd5b61399384828501613eb4565b60008060006060848603121561464e578081fd5b833567ffffffffffffffff80821115614665578283fd5b61467187838801613f0f565b94506020860135915080821115614686578283fd5b61469287838801613d88565b935060408601359150808211156146a7578283fd5b506146b486828701613fc8565b9150509250925092565b600080604083850312156146d0578182fd5b823567ffffffffffffffff808211156146e7578384fd5b6146f386838701613f0f565b93506020850135915080821115614708578283fd5b506144d085828601613e59565b600080600060608486031215614729578081fd5b835167ffffffffffffffff80821115614740578283fd5b61474c87838801613eb4565b94506020860151915080821115614761578283fd5b61476d87838801613f6a565b93506040860151915080821115614782578283fd5b506146b486828701613df4565b6000806000606084860312156147a3578081fd5b835167ffffffffffffffff808211156147ba578283fd5b6147c687838801613eb4565b9450602086015193506040860151915080821115614782578283fd5b600080604083850312156147f4578182fd5b823567ffffffffffffffff8082111561480b578384fd5b6146f386838701613fc8565b60008060408385031215614829578182fd5b825167ffffffffffffffff80821115614840578384fd5b61484c86838701613f6a565b93506020850151915080821115614861578283fd5b506144d085828601613df4565b60006020828403121561487f578081fd5b815180151581146120a5578182fd5b600080600080608085870312156148a3578182fd5b8451935060208501516148b581615816565b604086015190935067ffffffffffffffff80821115614452578384fd5b600080604083850312156148e4578182fd5b505080516020909101519092909150565b60008060408385031215614907578182fd5b82519150602083015167ffffffffffffffff811115614924578182fd5b6144d085828601614074565b600080600060608486031215614944578081fd5b83519250602084015167ffffffffffffffff80821115614962578283fd5b61496e87838801614074565b93506040860151915080821115614983578283fd5b506146b486828701614074565b600080604083850312156149a2578182fd5b8251915060208301516143a78161582b565b600080604083850312156149c6578182fd5b82516001600160e01b031981168114614396578283fd5b6000602082840312156149ee578081fd5b813567ffffffffffffffff811115614a04578182fd5b61399384828501614026565b60006060828403128015614a22578182fd5b8015614a2c578182fd5b50614a376060615750565b8251614a428161582b565b8152602083810151908201526040928301519281019290925250919050565b600060208284031215614a72578081fd5b815167ffffffffffffffff811115614a88578182fd5b61399384828501614209565b600080600060608486031215614aa8578081fd5b833567ffffffffffffffff811115614abe578182fd5b614aca868287016140ba565b9350506020840135614adb81615816565b929592945050506040919091013590565b60008060408385031215614afe578182fd5b823567ffffffffffffffff80821115614b15578384fd5b614b21868387016140ba565b93506020850135915080821115614b36578283fd5b506144d085828601614026565b60008060008060808587031215614b58578182fd5b845167ffffffffffffffff80821115614b6f578384fd5b614b7b88838901614209565b95506020870151915080821115614b90578384fd5b61443d88838901614209565b600080600060608486031215614bb0578081fd5b835167ffffffffffffffff80821115614bc7578283fd5b614bd387838801614209565b9450602086015193506040860151915080821115614983578283fd5b600060208284031215614c00578081fd5b5051919050565b60008060408385031215614c19578182fd5b8251614c248161582b565b6020939093015192949293505050565b600080600060608486031215614c48578081fd5b8351614c538161582b565b602085015160408601519194509250614c6b81615816565b809150509250925092565b60008060008060808587031215614c8b578182fd5b614c95868661434c565b9350602085015192506040850151614cac81615816565b606086015190925067ffffffffffffffff811115614cc8578182fd5b61448087828801614074565b600080600060608486031215614ce8578081fd5b614cf2858561434c565b925060208401519150604084015167ffffffffffffffff811115614d14578182fd5b6146b486828701614074565b600080600060608486031215614d34578081fd5b614d3e858561434c565b925060208401519150604084015190509250925092565b1515815260200190565b6000614d6b8383614e78565b505060600190565b6001600160a01b03169052565b6000815180845260208401935060208301825b82811015614dba5781516001600160a01b0316865260209586019590910190600101614d93565b5093949350505050565b600081518084526020840180819550602083028101915060208501845b84811015614e0f578284038852614df9848351614e4c565b6020988901989094509190910190600101614de1565b50919695505050505050565b6000815180845260208401935060208301825b82811015614dba578151865260209586019590910190600101614e2e565b60008151808452614e648160208601602086016157bb565b601f01601f19169290920160200192915050565b805160ff16825260208082015190830152604090810151910152565b60006101c0614ea4848451614d73565b6020830151614eb66020860182614d73565b506040830151614ec96040860182614d73565b506060830151614edc6060860182614d73565b506080830151608085015260a083015160a085015260c083015160c085015260e083015160e0850152610100808401518186015250610120808401518186015250610140808401518282870152614f3583870182614e4c565b91505061016091508184015185820383870152614f528282614e4c565b925050506101808084015185830382870152614f6e8382614e4c565b9150506101a091508184015185820383870152614f8b8282614e4c565b9695505050505050565b60008251614fa78184602087016157bb565b9190910192915050565b6001600160a01b0391909116815260200190565b6001600160a01b0392831681529116602082015260400190565b6001600160a01b039384168152919092166020820152604081019190915260600190565b60006001600160a01b0386168252608060208301526150256080830186614e1b565b82810360408401526150378186614e1b565b83810360608501526150498186614e4c565b98975050505050505050565b60006001600160a01b0386168252608060208301526150776080830186614e4c565b82810360408401526150378186614e4c565b6001600160a01b03929092168252602082015260400190565b6000608082526150b56080830187614dc4565b82810360208401526150c78187614d80565b83810360408501526150d98187614d80565b91505082810360608401526150ee8185614e1b565b979650505050505050565b602080825282518282018190526000918401906040840190835b8181101561513b5783516005811061512757fe5b835260209384019390920191600101615113565b509095945050505050565b6000606082016060835280865161515d8184615731565b9150602088019250835b8181101561518b5761517a838551614d5f565b602094909401939250600101615167565b5050838103602085015261519f8187614e1b565b91505082810360408401528084516151b78184615731565b9150602086019250835b818110156151e5576151d4838551614d55565b6020949094019392506001016151c1565b5090979650505050505050565b6000602082526120a56020830184614e1b565b6000604082526152186040830185614e1b565b828103602084015261522a8185614dc4565b95945050505050565b6000604082526152466040830185614e1b565b828103602084015261522a8185614e1b565b60008582526001600160a01b0385166020830152608060408301526152806080830185614e4c565b82810360608401526150ee8185614e4c565b918252602082015260400190565b6000838252604060208301526139936040830184614e4c565b6000848252606060208301526152d26060830185614e4c565b8281036040840152614f8b8185614e4c565b828152604081016152f48361580c565b8260208301529392505050565b6001600160e01b03199290921682526001600160a01b0316602082015260400190565b60006001600160e01b0319871682526001600160a01b038616602083015260a0604083015261535660a0830186614e1b565b82810360608401526153688186614e1b565b838103608085015261537a8186614e4c565b9998505050505050505050565b6001600160e01b03199390931683526001600160a01b03919091166020830152604082015260600190565b60006001600160e01b031985168252606060208301526153d56060830185614e1b565b8281036040840152614f8b8185614dc4565b6000602082526120a56020830184614e4c565b60006080825261540d6080830187614e4c565b6001600160a01b03958616602084015293909416604082015260ff9190911660609091015292915050565b6000615443856157eb565b8482528360208301526060604083015261522a6060830184614e4c565b6060810161546d856157f8565b938152602081019290925260409091015290565b6060810161548e85615802565b93815260208101929092526001600160a01b031660409091015290565b604081016154b8846157f8565b9281526020015290565b6060810161546d85615802565b606081016008851061546d57fe5b60208101600583106154eb57fe5b91905290565b60006154fc8661580c565b8582528460208301526001600160a01b038416604083015260806060830152614f8b6080830184614e4c565b604081016154b8846157eb565b6000608082526155486080830187614e4c565b602083820381850152818751808452828401915082838202850101838a01865b8381101561559657601f19878403018552615584838351614e94565b94860194925090850190600101615568565b505086810360408801526155aa818a614e1b565b94505050505082810360608401526150ee8185614dc4565b60208082526013908201527f554e4b4e4f574e5f52455455524e5f4441544100000000000000000000000000604082015260600190565b60208082526019908201527f554e4b4e4f574e5f46554e4354494f4e5f53454c4543544f5200000000000000604082015260600190565b6020808252600d908201527f554e494d504c454d454e54454400000000000000000000000000000000000000604082015260600190565b6020808252600c908201527f4241445f53454c4543544f520000000000000000000000000000000000000000604082015260600190565b6020808252600e908201527f57524f4e475f50524f58595f4944000000000000000000000000000000000000604082015260600190565b60a081016156e38286614e78565b8360608301528215156080830152949350505050565b6000602082526120a56020830184614e94565b60006040825261571f6040830185614e94565b828103602084015261522a8185614e4c565b90815260200190565b9283526020830191909152604082015260600190565b60405181810167ffffffffffffffff8111828210171561576f57600080fd5b604052919050565b600067ffffffffffffffff82111561578d578081fd5b5060209081020190565b600067ffffffffffffffff8211156157ad578081fd5b50601f01601f191660200190565b60005b838110156157d65781810151838201526020016157be565b838111156157e5576000848401525b50505050565b600281106157f557fe5b50565b600481106157f557fe5b600381106157f557fe5b600781106157f557fe5b6001600160a01b03811681146157f557600080fd5b60ff811681146157f557600080fdfea365627a7a723158200ea049525ebc74d73f3bf7858c601bd21168267b0dfb4abbdb7787cfd7233a2c6c6578706572696d656e74616cf564736f6c634300050c0040" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L31)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4241](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4241)* + +**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/dev_utils.ts:4194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4194)* + +**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/dev_utils.ts:4161](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4161)* + +**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 + +### decodeAssetProxyDispatchError + +#### ▪ **decodeAssetProxyDispatchError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L36)* + +Decompose an ABI-encoded AssetProxyDispatchError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L44)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[number, string, string]>`* + +errorCode The error code.orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:109](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L109)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:97](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L97)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L84)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeAssetProxyExistsError + +#### ▪ **decodeAssetProxyExistsError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L120)* + +Decompose an ABI-encoded AssetProxyExistsError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L128)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, string]>`* + +assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:193](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L193)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L181)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L168)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeAssetProxyTransferError + +#### ▪ **decodeAssetProxyTransferError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:204](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L204)* + +Decompose an ABI-encoded AssetProxyTransferError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L212)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[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. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:277](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L277)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:265](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L265)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:252](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L252)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeEIP1271SignatureError + +#### ▪ **decodeEIP1271SignatureError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:288](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L288)* + +Decompose an ABI-encoded SignatureValidatorError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:296](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L296)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[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. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:361](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L361)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L349)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L336)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeERC1155AssetData + +#### ▪ **decodeERC1155AssetData**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:374](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L374)* + +Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. + +#### callAsync + +▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:383](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L383)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* + +The ERC-1155 AssetProxy identifier, the address of the ERC-1155 contract hosting the assets, an array of the identifiers of the assets to be traded, an array of asset amounts to be traded, and callback data. Each element of the arrays corresponds to the same-indexed element of the other array. Return values specified as `memory` are returned as pointers to locations within the memory of the input parameter `assetData`. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`[], `BigNumber`[], string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L449)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, `BigNumber`[], `BigNumber`[], string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:437](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L437)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:426](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L426)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeERC20AssetData + +#### ▪ **decodeERC20AssetData**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:462](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L462)* + +Decode ERC-20 asset data from the format described in the AssetProxy contract specification. + +#### callAsync + +▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:470](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L470)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-20 asset. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, string]>`* + +The ERC-20 AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:533](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L533)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:521](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L521)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:510](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L510)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-20 asset. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeERC721AssetData + +#### ▪ **decodeERC721AssetData**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:544](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L544)* + +Decode ERC-721 asset data from the format described in the AssetProxy contract specification. + +#### callAsync + +▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:553](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-721 asset. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, string, BigNumber]>`* + +The ERC-721 AssetProxy identifier, the address of the ERC-721 contract hosting this asset, and the identifier of the specific asset to be traded. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L617)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:605](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L605)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:594](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L594)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-721 asset. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeExchangeInvalidContextError + +#### ▪ **decodeExchangeInvalidContextError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L628)* + +Decompose an ABI-encoded OrderStatusError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:636](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L636)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:701](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L701)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L689)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L676)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeFillError + +#### ▪ **decodeFillError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:712](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L712)* + +Decompose an ABI-encoded FillError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:720](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L720)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[number, string]>`* + +errorCode The error code.orderHash The order hash. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:783](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L783)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:771](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L771)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:760](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L760)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeIncompleteFillError + +#### ▪ **decodeIncompleteFillError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:794](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L794)* + +Decompose an ABI-encoded IncompleteFillError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, BigNumber, BigNumber]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:802](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L802)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[number, BigNumber, BigNumber]>`* + +orderHash Hash of the order being filled. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, `BigNumber`, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:867](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L867)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, `BigNumber`, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:855](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L855)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:842](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L842)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeMultiAssetData + +#### ▪ **decodeMultiAssetData**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:878](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L878)* + +Decode multi-asset data from the format described in the AssetProxy contract specification. + +#### callAsync + +▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, BigNumber[], string[]]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:886](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L886)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`assetData` | string | - | AssetProxy-compliant data describing a multi-asset basket. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, BigNumber[], string[]]>`* + +The Multi-Asset AssetProxy identifier, an array of the amounts of the assets to be traded, and an array of the AssetProxy-compliant data describing each asset to be traded. Each element of the arrays corresponds to the same-indexed element of the other array. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, `BigNumber`[], string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:949](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L949)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, `BigNumber`[], string[]]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:937](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L937)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:926](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L926)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant data describing a multi-asset basket. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeNegativeSpreadError + +#### ▪ **decodeNegativeSpreadError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:962](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L962)* + +Decompose an ABI-encoded NegativeSpreadError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:970](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L970)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, string]>`* + +leftOrderHash Hash of the left order being matched.rightOrderHash Hash of the right order being matched. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1035](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1035)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1023](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1023)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1010](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1010)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeOrderEpochError + +#### ▪ **decodeOrderEpochError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1046](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1046)* + +Decompose an ABI-encoded OrderEpochError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1054](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1054)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, string, BigNumber]>`* + +makerAddress The order maker.orderSenderAddress The order sender.currentEpoch The current epoch for the maker. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1117)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1105)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1094](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1094)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeOrderStatusError + +#### ▪ **decodeOrderStatusError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1128)* + +Decompose an ABI-encoded OrderStatusError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, number]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1136)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, number]>`* + +orderHash The order hash.orderStatus The order status. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, number]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1199](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1199)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, number]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1187](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1187)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1176](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1176)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeSignatureError + +#### ▪ **decodeSignatureError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1210](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1210)* + +Decompose an ABI-encoded SignatureError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1218](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1218)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[number, string, string, string]>`* + +errorCode The error code.signerAddress The expected signer of the hash.signature The full signature. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1281](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1281)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1269](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1269)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1258](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1258)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeSignatureValidatorNotApprovedError + +#### ▪ **decodeSignatureValidatorNotApprovedError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1294](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1294)* + +Decompose an ABI-encoded SignatureValidatorNotApprovedError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1302](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1302)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, string]>`* + +signerAddress The expected signer of the hash.validatorAddress The expected validator. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1370](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1370)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1358)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1344](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeSignatureWalletError + +#### ▪ **decodeSignatureWalletError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1381](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1381)* + +Decompose an ABI-encoded SignatureWalletError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1389)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`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. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1454](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1454)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string, string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1442)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1429)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeTransactionError + +#### ▪ **decodeTransactionError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1467](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1467)* + +Decompose an ABI-encoded TransactionError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1475](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1475)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[number, string]>`* + +errorCode The error code.transactionHash Hash of the transaction. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1538](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1538)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[number, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1526](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1526)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1515](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1515)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeTransactionExecutionError + +#### ▪ **decodeTransactionExecutionError**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1549](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1549)* + +Decompose an ABI-encoded TransactionExecutionError. + +#### callAsync + +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1557](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1557)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, string]>`* + +transactionHash Hash of the transaction.errorData Error thrown by exeucteTransaction(). + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1622)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, string]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1610](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1610)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1597](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1597)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decodeZeroExTransactionData + +#### ▪ **decodeZeroExTransactionData**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1633](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1633)* + +Decodes the call data for an Exchange contract method call. + +#### callAsync + +▸ **callAsync**(`transactionData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, Array, BigNumber[], string[]]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1642](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1642)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transactionData` | string | - | ABI-encoded calldata for an Exchange contract method call. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[string, Array, BigNumber[], string[]]>`* + +The name of the function called, and the parameters it was given. For single-order fills and cancels, the arrays will have just one element. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, `Array`, `BigNumber`[], string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1752](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1752)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[string, `Array`, `BigNumber`[], string[]]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1740](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1740)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1727](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1727)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionData` | string | ABI-encoded calldata for an Exchange contract method call. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### encodeERC1155AssetData + +#### ▪ **encodeERC1155AssetData**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1807](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1807)* + +Encode ERC-1155 asset data into the format described in the AssetProxy contract specification. + +#### callAsync + +▸ **callAsync**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1820](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1820)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`tokenAddress` | string | - | The address of the ERC-1155 contract hosting the asset(s) to be traded. | +`tokenIds` | `BigNumber`[] | - | The identifiers of the specific assets to be traded. | +`tokenValues` | `BigNumber`[] | - | The amounts of each asset to be traded. | +`callbackData` | string | - | Data to be passed to receiving contracts when a transfer is performed. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +AssetProxy-compliant asset data describing the set of assets. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1908](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1908)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1896](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1896)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1874](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1874)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | The address of the ERC-1155 contract hosting the asset(s) to be traded. | +`tokenIds` | `BigNumber`[] | The identifiers of the specific assets to be traded. | +`tokenValues` | `BigNumber`[] | The amounts of each asset to be traded. | +`callbackData` | string | Data to be passed to receiving contracts when a transfer is performed. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### encodeERC20AssetData + +#### ▪ **encodeERC20AssetData**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1919](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1919)* + +Encode ERC-20 asset data into the format described in the AssetProxy contract specification. + +#### callAsync + +▸ **callAsync**(`tokenAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1928](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1928)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`tokenAddress` | string | - | The address of the ERC-20 contract hosting the asset to be traded. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +AssetProxy-compliant data describing the asset. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1996](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1996)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1984](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1984)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1971](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1971)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | The address of the ERC-20 contract hosting the asset to be traded. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### encodeERC721AssetData + +#### ▪ **encodeERC721AssetData**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2007](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2007)* + +Encode ERC-721 asset data into the format described in the AssetProxy specification. + +#### callAsync + +▸ **callAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2017](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2017)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`tokenAddress` | string | - | The address of the ERC-721 contract hosting the asset to be traded. | +`tokenId` | `BigNumber` | - | The identifier of the specific asset to be traded. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +AssetProxy-compliant asset data describing the asset. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2091](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2091)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2079](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2079)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2064](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2064)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | The address of the ERC-721 contract hosting the asset to be traded. | +`tokenId` | `BigNumber` | The identifier of the specific asset to be traded. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### encodeMultiAssetData + +#### ▪ **encodeMultiAssetData**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2102)* + +Encode data for multiple assets, per the AssetProxy contract specification. + +#### callAsync + +▸ **callAsync**(`amounts`: `BigNumber`[], `nestedAssetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2112)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`amounts` | `BigNumber`[] | - | The amounts of each asset to be traded. | +`nestedAssetData` | string[] | - | AssetProxy-compliant data describing each asset to be traded. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +AssetProxy-compliant data describing the set of assets. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2186)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2174](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2174)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`[]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2159)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`amounts` | `BigNumber`[] | The amounts of each asset to be traded. | +`nestedAssetData` | string[] | AssetProxy-compliant data describing each asset to be traded. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getAssetProxyAllowance + +#### ▪ **getAssetProxyAllowance**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2197)* + +Returns the number of asset(s) (described by assetData) that the corresponding AssetProxy contract is authorized to spend. When the asset data contains multiple assets (eg for Multi-Asset), the return value indicates how many complete "baskets" of those assets may be spent by all of the corresponding AssetProxy contracts. + +#### callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2207](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2207)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`ownerAddress` | string | - | Owner of the assets specified by assetData. | +`assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2289)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2277](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2277)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2262](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2262)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getBalance + +#### ▪ **getBalance**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2300](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2300)* + +Returns the owner's balance of the assets(s) specified in assetData. When the asset data contains multiple assets (eg in ERC1155 or Multi-Asset), the return value indicates how many complete "baskets" of those assets are owned by owner. + +#### callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2310](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2310)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`ownerAddress` | string | - | Owner of the assets specified by assetData. | +`assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Number of assets (or asset baskets) held by owner. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2392)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2380](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2380)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2365](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2365)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getBalanceAndAssetProxyAllowance + +#### ▪ **getBalanceAndAssetProxyAllowance**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2403](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2403)* + +Calls getBalance() and getAllowance() for assetData. + +#### callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2413](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2413)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`ownerAddress` | string | - | Owner of the assets specified by assetData. | +`assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[BigNumber, BigNumber]>`* + +Number of assets (or asset baskets) held by owner, and number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2495](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2495)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`BigNumber`, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2483)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2468)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getBatchAssetProxyAllowances + +#### ▪ **getBatchAssetProxyAllowances**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2506](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2506)* + +Calls getAssetProxyAllowance() for each element of assetData. + +#### callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2516](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2516)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`ownerAddress` | string | - | Owner of the assets specified by assetData. | +`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2598](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2598)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2586](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2586)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2571](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2571)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getBatchBalances + +#### ▪ **getBatchBalances**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2609](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2609)* + +Calls getBalance() for each element of assetData. + +#### callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2619](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2619)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`ownerAddress` | string | - | Owner of the assets specified by assetData. | +`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2701](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2701)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2689)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2674)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getBatchBalancesAndAssetProxyAllowances + +#### ▪ **getBatchBalancesAndAssetProxyAllowances**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2712](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2712)* + +Calls getBatchBalances() and getBatchAllowances() for each element of assetData. + +#### callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2722](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2722)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`ownerAddress` | string | - | Owner of the assets specified by assetData. | +`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* + +An array of asset balances from getBalance(), and an array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`[], `BigNumber`[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2804](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2804)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`BigNumber`[], `BigNumber`[]]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2792](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2792)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2777](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2777)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getEthBalances + +#### ▪ **getEthBalances**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2815](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2815)* + +Batch fetches ETH balances + +#### callAsync + +▸ **callAsync**(`addresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2823](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2823)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`addresses` | string[] | - | Array of addresses. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Array of ETH balances. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2894](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2894)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2882](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2882)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string[]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`addresses`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2871](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2871)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`addresses` | string[] | Array of addresses. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getOrderRelevantState + +#### ▪ **getOrderRelevantState**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2905](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2905)* + +Fetches all order-relevant information needed to validate if the supplied order is fillable. + +#### callAsync + +▸ **callAsync**(`order`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, BigNumber, boolean]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2916](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2916)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`order` | object | - | The order structure. | +`signature` | string | - | Signature provided by maker that proves the order's authenticity. `0x01` can always be provided if the signature does not need to be validated. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[object, BigNumber, boolean]>`* + +The orderInfo (hash, status, and `takerAssetAmount` already filled for the given order), fillableTakerAssetAmount (amount of the order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (validity of the provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, `fillableTakerAssetAmount` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[object, `BigNumber`, boolean]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3078](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3078)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[object, `BigNumber`, boolean]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3024](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3024)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[object, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2992](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2992)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The order structure. | +`signature` | string | Signature provided by maker that proves the order's authenticity. `0x01` can always be provided if the signature does not need to be validated. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getOrderRelevantStates + +#### ▪ **getOrderRelevantStates**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3095](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3095)* + +Fetches all order-relevant information needed to validate if the supplied orders are fillable. + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, BigNumber[], boolean[]]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3106](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3106)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`orders` | `Array` | - | Array of order structures. | +`signatures` | string[] | - | Array of signatures provided by makers that prove the authenticity of the orders. `0x01` can always be provided if a signature does not need to be validated. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise<[Array, BigNumber[], boolean[]]>`* + +The ordersInfo (array of the hash, status, and `takerAssetAmount` already filled for each order), fillableTakerAssetAmounts (array of amounts for each order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (array containing the validity of each provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, each element of `fillableTakerAssetAmounts` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`Array`, `BigNumber`[], boolean[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3278](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3278)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`Array`, `BigNumber`[], boolean[]]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3224](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3224)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`Array`, string[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3191](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3191)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order structures. | +`signatures` | string[] | Array of signatures provided by makers that prove the authenticity of the orders. `0x01` can always be provided if a signature does not need to be validated. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getSimulatedOrderTransferResults + +#### ▪ **getSimulatedOrderTransferResults**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3303](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3303)* + +Simulates all of the transfers within an order and returns the index of the first failed transfer. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3368](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3368)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The 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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3509](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3509)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 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) | - | - | + +**Returns:** *`Promise`* + +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 [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3421](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3421)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**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 | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3663](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3663)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *number* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3617)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3583](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3583)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The order to simulate transfers for. | +`takerAddress` | string | The address of the taker that will fill the order. | +`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3314](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3314)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The 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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3464](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3464)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAddress` | string | +`takerAssetFillAmount` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### getSimulatedOrdersTransferResults + +#### ▪ **getSimulatedOrdersTransferResults**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3676)* + +Simulates all of the transfers for each given order and returns the indices of each first failed transfer. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3744](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3744)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of 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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3889](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3889)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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 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) | - | - | + +**Returns:** *`Promise`* + +The indices of the first failed transfer (or 4 if all transfers are successful) for each order. + +#### estimateGasAsync + +▸ **estimateGasAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3799](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3799)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**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 | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4048](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4048)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *number[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4000](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4000)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3965](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3965)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 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:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3688)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of 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 | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3843](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3843)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAddresses` | string[] | +`takerAssetFillAmounts` | `BigNumber`[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### getTransferableAssetAmount + +#### ▪ **getTransferableAssetAmount**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4061](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4061)* + +Gets the amount of an asset transferable by the owner. + +#### callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4071](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4071)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`ownerAddress` | string | - | Address of the owner of the asset. | +`assetData` | string | - | Description of tokens, per the AssetProxy contract specification. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The amount of the asset tranferable by the owner. NOTE: If the `assetData` encodes data for multiple assets, the `transferableAssetAmount` will represent the amount of times the entire `assetData` can be transferred. To calculate the total individual transferable amounts, this scaled `transferableAmount` must be multiplied by the individual asset amounts located within the `assetData`. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4153](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4153)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4141)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4126](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4126)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Address of the owner of the asset. | +`assetData` | string | Description of tokens, per the AssetProxy contract specification. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +
+ +# Class: DummyERC20TokenContract + + +## Constructors + + + +\+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2381](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2381)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | DummyERC20TokenContract.deployedBytecode | + +**Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b50600436106100ea5760003560e01c806395d89b411161008c578063dd62ed3e11610066578063dd62ed3e146102e2578063e30443bc1461031d578063f2fde38b14610356578063fa9b701814610389576100ea565b806395d89b4114610282578063a0712d681461028a578063a9059cbb146102a9576100ea565b806323b872dd116100c857806323b872dd146101d3578063313ce5671461021657806370a082311461021e5780638da5cb5b14610251576100ea565b806306fdde03146100ef578063095ea7b31461016c57806318160ddd146101b9575b600080fd5b6100f7610391565b6040805160208082528351818301528351919283929083019185019080838360005b83811015610131578181015183820152602001610119565b50505050905090810190601f16801561015e5780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b6101a56004803603604081101561018257600080fd5b5073ffffffffffffffffffffffffffffffffffffffff813516906020013561043d565b604080519115158252519081900360200190f35b6101c16104b0565b60408051918252519081900360200190f35b6101a5600480360360608110156101e957600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135811691602081013590911690604001356104b6565b6101c1610772565b6101c16004803603602081101561023457600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610778565b6102596107a0565b6040805173ffffffffffffffffffffffffffffffffffffffff9092168252519081900360200190f35b6100f76107bc565b6102a7600480360360208110156102a057600080fd5b5035610835565b005b6101a5600480360360408110156102bf57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81351690602001356108bb565b6101c1600480360360408110156102f857600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81358116916020013516610a4a565b6102a76004803603604081101561033357600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135169060200135610a82565b6102a76004803603602081101561036c57600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610b18565b6101c1610b95565b6004805460408051602060026001851615610100027fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190941693909304601f810184900484028201840190925281815292918301828280156104355780601f1061040a57610100808354040283529160200191610435565b820191906000526020600020905b81548152906001019060200180831161041857829003601f168201915b505050505081565b33600081815260026020908152604080832073ffffffffffffffffffffffffffffffffffffffff8716808552908352818420869055815186815291519394909390927f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925928290030190a350600192915050565b60035490565b73ffffffffffffffffffffffffffffffffffffffff83166000818152600260209081526040808320338452825280832054938352600190915281205490919083111561056357604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601a60248201527f45524332305f494e53554646494349454e545f42414c414e4345000000000000604482015290519081900360640190fd5b828110156105d257604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601c60248201527f45524332305f494e53554646494349454e545f414c4c4f57414e434500000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8416600090815260016020526040902054838101101561066857604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601060248201527f55494e543235365f4f564552464c4f5700000000000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff808516600090815260016020526040808220805487019055918716815220805484900390557fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8110156107025773ffffffffffffffffffffffffffffffffffffffff851660009081526002602090815260408083203384529091529020805484900390555b8373ffffffffffffffffffffffffffffffffffffffff168573ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef856040518082815260200191505060405180910390a3506001949350505050565b60065481565b73ffffffffffffffffffffffffffffffffffffffff1660009081526001602052604090205490565b60005473ffffffffffffffffffffffffffffffffffffffff1681565b6005805460408051602060026001851615610100027fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190941693909304601f810184900484028201840190925281815292918301828280156104355780601f1061040a57610100808354040283529160200191610435565b69021e19e0c9bab24000008111156108ae57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152600f60248201527f56414c55455f544f4f5f4c415247450000000000000000000000000000000000604482015290519081900360640190fd5b6108b83382610ba3565b50565b3360009081526001602052604081205482111561093957604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601a60248201527f45524332305f494e53554646494349454e545f42414c414e4345000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff831660009081526001602052604090205482810110156109cf57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601060248201527f55494e543235365f4f564552464c4f5700000000000000000000000000000000604482015290519081900360640190fd5b3360008181526001602090815260408083208054879003905573ffffffffffffffffffffffffffffffffffffffff871680845292819020805487019055805186815290519293927fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef929181900390910190a350600192915050565b73ffffffffffffffffffffffffffffffffffffffff918216600090815260026020908152604080832093909416825291909152205490565b610a8a610c5c565b73ffffffffffffffffffffffffffffffffffffffff821660009081526001602052604090205480821015610ad557610acd600354610ac88385610ca5565b610ca5565b600355610aee565b610aea600354610ae58484610ca5565b610cc4565b6003555b5073ffffffffffffffffffffffffffffffffffffffff909116600090815260016020526040902055565b610b20610c5c565b73ffffffffffffffffffffffffffffffffffffffff8116610b5057610b4b610b46610ce7565b610d1e565b6108b8565b6000805473ffffffffffffffffffffffffffffffffffffffff83167fffffffffffffffffffffffff000000000000000000000000000000000000000090911617905550565b69021e19e0c9bab240000081565b73ffffffffffffffffffffffffffffffffffffffff8216600090815260016020526040902054610bd4908290610cc4565b73ffffffffffffffffffffffffffffffffffffffff8316600090815260016020526040902055600354610c079082610cc4565b60035560408051828152905173ffffffffffffffffffffffffffffffffffffffff8416916000917fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9181900360200190a35050565b60005473ffffffffffffffffffffffffffffffffffffffff163314610ca357600054610ca390610b4690339073ffffffffffffffffffffffffffffffffffffffff16610d26565b565b600082821115610cbe57610cbe610b4660028585610db2565b50900390565b600082820183811015610ce057610ce0610b4660008686610db2565b9392505050565b60408051808201909152600481527fe69edc3e00000000000000000000000000000000000000000000000000000000602082015290565b805160208201fd5b6040805173ffffffffffffffffffffffffffffffffffffffff808516602483015283166044808301919091528251808303909101815260649091019091526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f1de45ad10000000000000000000000000000000000000000000000000000000017905292915050565b606063e946c1bb60e01b84848460405160240180846003811115610dd257fe5b60ff1681526020018381526020018281526020019350505050604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050509050939250505056fea265627a7a7231582089c03e503c77db7069bea8a94ec1c47ee5201d8bdb53857e70a882a1130e1ac364736f6c634300050c0032" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L51)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2365](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2365)* + +Gets historical logs without creating a subscription + +**Type parameters:** + +▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`eventName` | [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents) | The DummyERC20Token contract event you would like to subscribe to. | +`blockRange` | `BlockRange` | Block range to get logs from. | +`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | + +**Returns:** *`Promise>>`* + +Array of logs that match the parameters + +___ + +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2323](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2323)* + +Subscribe to an event type emitted by the DummyERC20Token contract. + +**Type parameters:** + +▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`eventName` | [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents) | - | The DummyERC20Token contract event you would like to subscribe to. | +`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | +`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | +`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | +`blockPollingIntervalMs?` | undefined \| number | - | - | + +**Returns:** *string* + +Subscription token used later to unsubscribe + +___ + +### unsubscribe + +▸ **unsubscribe**(`subscriptionToken`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2348](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2348)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2354](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2354)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1994](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1994)* + +**Returns:** *[ContractAbi](#contractabi)* + +The contract ABI + +___ + +### `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1944](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1944)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | +`_decimals` | `BigNumber` | +`_totalSupply` | `BigNumber` | + +**Returns:** *`Promise`* + +___ + +### `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1905](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1905)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | +`_decimals` | `BigNumber` | +`_totalSupply` | `BigNumber` | + +**Returns:** *`Promise`* + +___ + +### `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + +Defined in base-contract/lib/src/index.d.ts:41 + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +## Object literals + +### MAX_MINT_AMOUNT + +#### ▪ **MAX_MINT_AMOUNT**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L53)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L59)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:123](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L123)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L111)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:101](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L101)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### allowance + +#### ▪ **allowance**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L131)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:140](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L140)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address of the account owning tokens | +`_spender` | string | - | The address of the account able to transfer the tokens | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Amount of remaining tokens allowed to spent + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:221](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L221)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L209)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L194)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address of the account owning tokens | +`_spender` | string | The address of the account able to transfer the tokens | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### approve + +#### ▪ **approve**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:232](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L232)* + +`msg.sender` approves `_spender` to spend `_value` tokens + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:277](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L277)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:351](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L351)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_spender` | string | - | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | - | The amount of wei to be approved for transfer | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Always true if the call has enough gas to complete execution + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:307](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L307)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L432)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L420)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:405](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L405)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:241](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L241)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:334](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L334)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:443](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L443)* + +Query the balance of owner + +#### callAsync + +▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:451](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L451)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address from which the balance will be retrieved | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Balance of owner + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:522](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L522)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:510](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L510)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:499](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L499)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address from which the balance will be retrieved | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decimals + +#### ▪ **decimals**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:530](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L530)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:536](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L536)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:600](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L600)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:588](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L588)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:578](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L578)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### mint + +#### ▪ **mint**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:611](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L611)* + +Mints new tokens for sender + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:646](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L646)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_value` | `BigNumber` | Amount of tokens to mint | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:706](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L706)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_value` | `BigNumber` | - | Amount of tokens to mint | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:673](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L673)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_value` | `BigNumber` | Amount of tokens to mint | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:773](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L773)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:761](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L761)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:750](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L750)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_value` | `BigNumber` | Amount of tokens to mint | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:619](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_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 | Description | +------ | ------ | ------ | +`_value` | `BigNumber` | Amount of tokens to mint | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:692](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L692)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### name + +#### ▪ **name**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:781](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L781)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:787](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L787)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:851](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L851)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:839](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L839)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:829](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L829)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### owner + +#### ▪ **owner**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:859](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L859)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:865](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L865)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:929](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L929)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:917](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L917)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:907](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L907)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### setBalance + +#### ▪ **setBalance**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:940](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L940)* + +Sets the balance of target address + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:985](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L985)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_target` | string | Address or which balance will be updated | +`_value` | `BigNumber` | New balance of target address | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_target`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1058](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1058)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_target` | string | - | Address or which balance will be updated | +`_value` | `BigNumber` | - | New balance of target address | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1015](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1015)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_target` | string | Address or which balance will be updated | +`_value` | `BigNumber` | New balance of target address | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1139](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1139)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1127](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1127)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_target`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1112)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_target` | string | Address or which balance will be updated | +`_value` | `BigNumber` | New balance of target address | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:949](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L949)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_target` | string | Address or which balance will be updated | +`_value` | `BigNumber` | New balance of target address | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1042](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1042)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_target` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### symbol + +#### ▪ **symbol**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1147](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1147)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1153](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1153)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1217)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1205](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1205)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1195](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1195)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### totalSupply + +#### ▪ **totalSupply**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1228](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1228)* + +Query total supply of token + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1235](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1235)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +Total supply of token + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1299](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1299)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1287](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1287)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1277](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1277)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transfer + +#### ▪ **transfer**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1310](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1310)* + +send `value` token to `to` from `msg.sender` + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1352](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1352)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1419](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1419)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_to` | string | - | The address of the recipient | +`_value` | `BigNumber` | - | The amount of token to be transferred | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +True if transfer was successful + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1382](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1382)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1497](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1497)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1485](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1485)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1470](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1470)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1319](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1319)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1402](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1402)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1508](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1508)* + +ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. See https://github.com/ethereum/EIPs/issues/717 + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1558](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1558)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1645](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1645)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_from` | string | - | Address to transfer from. | +`_to` | string | - | Address to transfer to. | +`_value` | `BigNumber` | - | Amount to transfer. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Success of transfer. + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1596](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1596)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1732](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1732)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1720](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1720)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1703](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1703)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1518](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1518)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1626](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1626)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferOwnership + +#### ▪ **transferOwnership**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1740](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1740)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1773](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1773)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1828](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1828)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`newOwner` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1799](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1799)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1896](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1896)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1884](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1884)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1871](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1871)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1747](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1747)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1818](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1818)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: DummyERC721TokenContract + + +## Constructors + + + +\+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2917](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2917)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | DummyERC721TokenContract.deployedBytecode | + +**Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b50600436106100f55760003560e01c806370a0823111610097578063a22cb46511610066578063a22cb46514610362578063b88d4fde1461039d578063e985e9c51461043a578063f2fde38b14610489576100f5565b806370a08231146102d45780638da5cb5b1461031957806395d89b41146103215780639dc29fac14610329576100f5565b806323b872dd116100d357806323b872dd146101f857806340c10f191461023b57806342842e0e146102745780636352211e146102b7576100f5565b806306fdde03146100fa578063081812fc14610177578063095ea7b3146101bd575b600080fd5b6101026104bc565b6040805160208082528351818301528351919283929083019185019080838360005b8381101561013c578181015183820152602001610124565b50505050905090810190601f1680156101695780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b6101946004803603602081101561018d57600080fd5b5035610568565b6040805173ffffffffffffffffffffffffffffffffffffffff9092168252519081900360200190f35b6101f6600480360360408110156101d357600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135169060200135610590565b005b6101f66004803603606081101561020e57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135811691602081013590911690604001356106b2565b6101f66004803603604081101561025157600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135169060200135610a20565b6101f66004803603606081101561028a57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff813581169160208101359091169060400135610a2e565b610194600480360360208110156102cd57600080fd5b5035610bc8565b610307600480360360208110156102ea57600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610c5f565b60408051918252519081900360200190f35b610194610d0c565b610102610d28565b6101f66004803603604081101561033f57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135169060200135610da1565b6101f66004803603604081101561037857600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81351690602001351515610db3565b6101f6600480360360808110156103b357600080fd5b73ffffffffffffffffffffffffffffffffffffffff8235811692602081013590911691604082013591908101906080810160608201356401000000008111156103fb57600080fd5b82018360208201111561040d57600080fd5b8035906020019184600183028401116401000000008311171561042f57600080fd5b509092509050610e4c565b6104756004803603604081101561045057600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81358116916020013516611017565b604080519115158252519081900360200190f35b6101f66004803603602081101561049f57600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16611052565b6005805460408051602060026001851615610100027fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190941693909304601f810184900484028201840190925281815292918301828280156105605780601f1061053557610100808354040283529160200191610560565b820191906000526020600020905b81548152906001019060200180831161054357829003601f168201915b505050505081565b60009081526002602052604090205473ffffffffffffffffffffffffffffffffffffffff1690565b600061059b82610bc8565b90503373ffffffffffffffffffffffffffffffffffffffff821614806105c657506105c68133611017565b61063157604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f4552433732315f494e56414c49445f53454e4445520000000000000000000000604482015290519081900360640190fd5b60008281526002602052604080822080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff87811691821790925591518593918516917f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92591a4505050565b73ffffffffffffffffffffffffffffffffffffffff821661073457604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601660248201527f4552433732315f5a45524f5f544f5f4144445245535300000000000000000000604482015290519081900360640190fd5b600061073f82610bc8565b90508073ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff16146107db57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f4552433732315f4f574e45525f4d49534d415443480000000000000000000000604482015290519081900360640190fd5b3360006107e784610568565b90508273ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16148061082857506108288383611017565b8061085e57508173ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16145b6108c957604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601660248201527f4552433732315f494e56414c49445f5350454e44455200000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff81161561091a57600084815260026020526040902080547fffffffffffffffffffffffff00000000000000000000000000000000000000001690555b600084815260016020818152604080842080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff8b8116919091179091558a168452600390915290912054610984916110ce565b73ffffffffffffffffffffffffffffffffffffffff80881660009081526003602052604080822093909355908716815220546109c19060016110ed565b73ffffffffffffffffffffffffffffffffffffffff808716600081815260036020526040808220949094559251879391928a16917fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef91a4505050505050565b610a2a8282611110565b5050565b610a398383836106b2565b813b8015610bc257604080517f150b7a0200000000000000000000000000000000000000000000000000000000815233600482015273ffffffffffffffffffffffffffffffffffffffff8681166024830152604482018590526080606483015260006084830181905292519086169163150b7a029160c480830192602092919082900301818787803b158015610ace57600080fd5b505af1158015610ae2573d6000803e3d6000fd5b505050506040513d6020811015610af857600080fd5b505160405190915080602f61166c8239602f01905060405180910390207bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614610bc057604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4552433732315f494e56414c49445f53454c4543544f52000000000000000000604482015290519081900360640190fd5b505b50505050565b60008181526001602052604081205473ffffffffffffffffffffffffffffffffffffffff1680610c5957604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601160248201527f4552433732315f5a45524f5f4f574e4552000000000000000000000000000000604482015290519081900360640190fd5b92915050565b600073ffffffffffffffffffffffffffffffffffffffff8216610ce357604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601160248201527f4552433732315f5a45524f5f4f574e4552000000000000000000000000000000604482015290519081900360640190fd5b5073ffffffffffffffffffffffffffffffffffffffff1660009081526003602052604090205490565b60005473ffffffffffffffffffffffffffffffffffffffff1681565b6006805460408051602060026001851615610100027fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190941693909304601f810184900484028201840190925281815292918301828280156105605780601f1061053557610100808354040283529160200191610560565b610da96112e3565b610a2a828261132c565b33600081815260046020908152604080832073ffffffffffffffffffffffffffffffffffffffff87168085529083529281902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016861515908117909155815190815290519293927f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31929181900390910190a35050565b610e578585856106b2565b833b801561100f576040517f150b7a02000000000000000000000000000000000000000000000000000000008152336004820181815273ffffffffffffffffffffffffffffffffffffffff89811660248501526044840188905260806064850190815260848501879052600094918a169363150b7a029390928c928b928b928b929060a401848480828437600081840152601f19601f8201169050808301925050509650505050505050602060405180830381600087803b158015610f1b57600080fd5b505af1158015610f2f573d6000803e3d6000fd5b505050506040513d6020811015610f4557600080fd5b505160405190915080602f61166c8239602f01905060405180910390207bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19161461100d57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4552433732315f494e56414c49445f53454c4543544f52000000000000000000604482015290519081900360640190fd5b505b505050505050565b73ffffffffffffffffffffffffffffffffffffffff918216600090815260046020908152604080832093909416825291909152205460ff1690565b61105a6112e3565b73ffffffffffffffffffffffffffffffffffffffff811661108a57611085611080611501565b611538565b6110cb565b600080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff83161790555b50565b6000828211156110e7576110e761108060028585611540565b50900390565b6000828201838110156111095761110961108060008686611540565b9392505050565b73ffffffffffffffffffffffffffffffffffffffff821661119257604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601660248201527f4552433732315f5a45524f5f544f5f4144445245535300000000000000000000604482015290519081900360640190fd5b60008181526001602052604090205473ffffffffffffffffffffffffffffffffffffffff16801561122457604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601b60248201527f4552433732315f4f574e45525f414c52454144595f4558495354530000000000604482015290519081900360640190fd5b600082815260016020818152604080842080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff8916908117909155845260039091529091205461128a916110ed565b73ffffffffffffffffffffffffffffffffffffffff84166000818152600360205260408082209390935591518492907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef908290a4505050565b60005473ffffffffffffffffffffffffffffffffffffffff16331461132a5760005461132a9061108090339073ffffffffffffffffffffffffffffffffffffffff166115df565b565b73ffffffffffffffffffffffffffffffffffffffff82166113ae57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601960248201527f4552433732315f5a45524f5f4f574e45525f4144445245535300000000000000604482015290519081900360640190fd5b60008181526001602052604090205473ffffffffffffffffffffffffffffffffffffffff908116908316811461144557604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f4552433732315f4f574e45525f4d49534d415443480000000000000000000000604482015290519081900360640190fd5b600082815260016020818152604080842080547fffffffffffffffffffffffff000000000000000000000000000000000000000016905573ffffffffffffffffffffffffffffffffffffffff871684526003909152909120546114a7916110ce565b73ffffffffffffffffffffffffffffffffffffffff8416600081815260036020526040808220939093559151849291907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef908390a4505050565b60408051808201909152600481527fe69edc3e00000000000000000000000000000000000000000000000000000000602082015290565b805160208201fd5b606063e946c1bb60e01b8484846040516024018084600381111561156057fe5b60ff1681526020018381526020018281526020019350505050604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff838183161783525050505090509392505050565b6040805173ffffffffffffffffffffffffffffffffffffffff808516602483015283166044808301919091528251808303909101815260649091019091526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f1de45ad1000000000000000000000000000000000000000000000000000000001790529291505056fe6f6e455243373231526563656976656428616464726573732c616464726573732c75696e743235362c627974657329a265627a7a723158207bb3c4b1d40aa051fbb8e4f8230bb310013e75ca9fa97c528018b4c4aba3b92564736f6c634300050c0032" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L61)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2901](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2901)* + +Gets historical logs without creating a subscription + +**Type parameters:** + +▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`eventName` | [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents) | The DummyERC721Token contract event you would like to subscribe to. | +`blockRange` | `BlockRange` | Block range to get logs from. | +`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | + +**Returns:** *`Promise>>`* + +Array of logs that match the parameters + +___ + +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2859](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2859)* + +Subscribe to an event type emitted by the DummyERC721Token contract. + +**Type parameters:** + +▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`eventName` | [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents) | - | The DummyERC721Token contract event you would like to subscribe to. | +`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | +`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | +`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | +`blockPollingIntervalMs?` | undefined \| number | - | - | + +**Returns:** *string* + +Subscription token used later to unsubscribe + +___ + +### unsubscribe + +▸ **unsubscribe**(`subscriptionToken`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2884](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2884)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2890](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2890)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2482](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2482)* + +**Returns:** *[ContractAbi](#contractabi)* + +The contract ABI + +___ + +### `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2434)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | + +**Returns:** *`Promise`* + +___ + +### `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2399](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2399)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | + +**Returns:** *`Promise`* + +___ + +### `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + +Defined in base-contract/lib/src/index.d.ts:41 + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +## Object literals + +### approve + +#### ▪ **approve**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L68)* + +The zero address indicates there is no approved address. +Throws unless `msg.sender` is the current NFT owner, or an authorized +operator of the current owner. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:113](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L113)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L186)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_approved` | string | - | The new approved NFT controller | +`_tokenId` | `BigNumber` | - | The NFT to approve | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:143](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L143)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:267](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L267)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:255](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L255)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:240](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L240)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:77](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L77)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L170)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_approved` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:279](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L279)* + +NFTs assigned to the zero address are considered invalid, and this +function throws for queries about the zero address. + +#### callAsync + +▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:287](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L287)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | An address for whom to query the balance | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The number of NFTs owned by `_owner`, possibly zero + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L358)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:346](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L346)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L335)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | An address for whom to query the balance | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### burn + +#### ▪ **burn**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:370](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L370)* + +Function to burn a token +Reverts if the given token ID doesn't exist or not called by contract owner + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:412](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L412)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | Owner of token with given token ID | +`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:482](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L482)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | Owner of token with given token ID | +`_tokenId` | `BigNumber` | - | ID of the token to be burned by the msg.sender | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L442)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | Owner of token with given token ID | +`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:560](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L560)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:548](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L548)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:533](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L533)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | Owner of token with given token ID | +`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:379](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L379)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | Owner of token with given token ID | +`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:466](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L466)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_owner` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### getApproved + +#### ▪ **getApproved**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:571](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L571)* + +Throws if `_tokenId` is not a valid NFT. + +#### callAsync + +▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:579](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L579)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_tokenId` | `BigNumber` | - | The NFT to find the approved address for | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The approved address for this NFT, or the zero address if there is none + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:650](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L650)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:638](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L638)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:627](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L627)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The NFT to find the approved address for | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### isApprovedForAll + +#### ▪ **isApprovedForAll**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:658](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L658)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:667](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L667)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address that owns the NFTs | +`_operator` | string | - | The address that acts on behalf of the owner | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +True if `_operator` is an approved operator for `_owner`, false otherwise + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:748](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L748)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:736](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L736)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:721](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L721)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address that owns the NFTs | +`_operator` | string | The address that acts on behalf of the owner | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### mint + +#### ▪ **mint**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:760](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L760)* + +Function to mint a new token +Reverts if the given token ID already exists + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:802](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L802)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | Address of the beneficiary that will own the minted token | +`_tokenId` | `BigNumber` | ID of the token to be minted by the msg.sender | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:872](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L872)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:832](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L832)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | Address of the beneficiary that will own the minted token | +`_tokenId` | `BigNumber` | ID of the token to be minted by the msg.sender | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:950](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L950)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:938](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L938)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:923](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L923)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | Address of the beneficiary that will own the minted token | +`_tokenId` | `BigNumber` | ID of the token to be minted by the msg.sender | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:769](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L769)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | Address of the beneficiary that will own the minted token | +`_tokenId` | `BigNumber` | ID of the token to be minted by the msg.sender | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:856](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L856)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### name + +#### ▪ **name**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:958](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L958)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:964](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L964)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1028](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1028)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1016](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1016)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1006](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1006)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### owner + +#### ▪ **owner**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1036](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1036)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1042](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1042)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1106](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1106)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1094](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1094)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1084](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1084)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### ownerOf + +#### ▪ **ownerOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1118)* + +NFTs assigned to zero address are considered invalid, and queries +about them do throw. + +#### callAsync + +▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1126](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1126)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_tokenId` | `BigNumber` | - | The identifier for an NFT | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The address of the owner of the NFT + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1197)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1185](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1185)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1174](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1174)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The identifier for an NFT | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### safeTransferFrom1 + +#### ▪ **safeTransferFrom1**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1209)* + +This works identically to the other function with an extra data parameter, +except this function just sets data to "". + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1259](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1259)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1345](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1345)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_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:1297](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1297)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1432)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1420)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1403](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1403)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1219)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1327](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1327)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### safeTransferFrom2 + +#### ▪ **safeTransferFrom2**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1449)* + +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. When transfer is complete, this function +checks if `_to` is a smart contract (code size > 0). If so, it calls +`onERC721Received` on `_to` and throws if the return value is not +`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1504](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1504)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1605](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1605)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_from` | string | - | The current owner of the NFT | +`_to` | string | - | The new owner | +`_tokenId` | `BigNumber` | - | The NFT to transfer | +`_data` | string | - | Additional data with no specified format, sent in call to `_to` | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1546](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1546)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1696](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1696)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1684](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1684)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, `BigNumber`, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1667](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1667)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1460](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1460)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1579](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1579)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`_data` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### setApprovalForAll + +#### ▪ **setApprovalForAll**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1708](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1708)* + +Emits the ApprovalForAll event. The contract MUST allow +multiple operators per owner. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1753](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1753)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_operator`: string, `_approved`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1830](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1830)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1787](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1787)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1911](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1911)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1899](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1899)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, boolean]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1884](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1884)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1717](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1717)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1814](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1814)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_operator` | string | +`_approved` | boolean | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### symbol + +#### ▪ **symbol**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1919](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1919)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1925](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1925)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1989](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1989)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1977](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1977)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1967](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1967)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2003](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2003)* + +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2053](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2053)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2139](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2139)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:2091](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2091)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2226](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2226)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2214](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2214)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2197)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2013](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2013)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2121)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferOwnership + +#### ▪ **transferOwnership**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2234](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2234)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2267](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2267)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2322](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2322)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:2293](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2293)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2390)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2378](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2378)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2365](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2365)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2241](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2241)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2312](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2312)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: DutchAuctionContract + + +## Constructors + + + +\+ **new DutchAuctionContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DutchAuctionContract](#class-dutchauctioncontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:1257](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L1257)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | DutchAuctionContract.deployedBytecode | + +**Returns:** *[DutchAuctionContract](#class-dutchauctioncontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string | undefined* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L31)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:965](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L965)* + +**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:918](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L918)* + +**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:885](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L885)* + +**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:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L35)* + +Calculates the Auction Details for the given order + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:88](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L88)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The sell order | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L192)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`order` | object | - | The sell order | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +AuctionDetails + +#### estimateGasAsync + +▸ **estimateGasAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:127](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L127)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The sell order | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:339](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L339)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:297](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L297)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:271](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L271)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The sell order | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L43)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The sell order | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:164](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L164)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### matchOrders + +#### ▪ **matchOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:382](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L382)* + +Matches the buy and sell orders at an amount given the following: the current block time, the auction +start time and the auction begin amount. The sell order is a an order at the lowest amount +at the end of the auction. Excess from the match is transferred to the seller. +Over time the price moves from beginAmount to endAmount given the current block.timestamp. +sellOrder.expiryTimeSeconds is the end time of the auction. +sellOrder.takerAssetAmount is the end amount of the auction (lowest possible amount). +sellOrder.makerAssetData is the ABI encoded Asset Proxy data with the following data appended +buyOrder.makerAssetData is the buyers bid on the auction, must meet the amount for the current block timestamp +(uint256 beginTimeSeconds, uint256 beginAmount). +This function reverts in the following scenarios: +* Auction has not started (auctionDetails.currentTimeSeconds < auctionDetails.beginTimeSeconds) +* Auction has expired (auctionDetails.endTimeSeconds < auctionDetails.currentTimeSeconds) +* Amount is invalid: Buy order amount is too low (buyOrder.makerAssetAmount < auctionDetails.currentAmount) +* Amount is invalid: Invalid begin amount (auctionDetails.beginAmount > auctionDetails.endAmount) +* Any failure in the 0x Match Orders + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:463](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L463)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | +`sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | +`buySignature` | string | Proof that order was created by the buyer. | +`sellSignature` | string | Proof that order was created by the seller. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L641)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:531](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L531)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | +`sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | +`buySignature` | string | Proof that order was created by the buyer. | +`sellSignature` | string | Proof that order was created by the seller. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:845](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L845)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L803)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:757](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L757)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | +`sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | +`buySignature` | string | Proof that order was created by the buyer. | +`sellSignature` | string | Proof that order was created by the seller. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:395](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L395)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | +`sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | +`buySignature` | string | Proof that order was created by the buyer. | +`sellSignature` | string | Proof that order was created by the seller. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:586](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L586)* + +**Parameters:** + +Name | Type | +------ | ------ | +`buyOrder` | object | +`sellOrder` | object | +`buySignature` | string | +`sellSignature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ERC1155ProxyContract + + +## Constructors + + + +\+ **new ERC1155ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC1155ProxyContract](#class-erc1155proxycontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1787](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1787)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC1155ProxyContract.deployedBytecode | + +**Returns:** *[ERC1155ProxyContract](#class-erc1155proxycontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b50600436106100be5760003560e01c8063a85e59e411610076578063b91816111161005b578063b918161114610285578063d39de6e9146102cc578063f2fde38b14610324576100be565b8063a85e59e4146101b2578063ae25532e14610248576100be565b806370712939116100a7578063707129391461013e5780638da5cb5b146101715780639ad2674414610179576100be565b806342f1181e146100c3578063494503d4146100f8575b600080fd5b6100f6600480360360208110156100d957600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610357565b005b6101156004803603602081101561010e57600080fd5b5035610543565b6040805173ffffffffffffffffffffffffffffffffffffffff9092168252519081900360200190f35b6100f66004803603602081101561015457600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610577565b61011561086a565b6100f66004803603604081101561018f57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135169060200135610886565b6100f6600480360360808110156101c857600080fd5b8101906020810181356401000000008111156101e357600080fd5b8201836020820111156101f557600080fd5b8035906020019184600183028401116401000000008311171561021757600080fd5b919350915073ffffffffffffffffffffffffffffffffffffffff813581169160208101359091169060400135610c37565b610250611138565b604080517fffffffff000000000000000000000000000000000000000000000000000000009092168252519081900360200190f35b6102b86004803603602081101561029b57600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16611159565b604080519115158252519081900360200190f35b6102d461116e565b60408051602080825283518183015283519192839290830191858101910280838360005b838110156103105781810151838201526020016102f8565b505050509050019250505060405180910390f35b6100f66004803603602081101561033a57600080fd5b503573ffffffffffffffffffffffffffffffffffffffff166111dd565b60005473ffffffffffffffffffffffffffffffffffffffff1633146103dd57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff811660009081526001602052604090205460ff161561047257604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601960248201527f5441524745545f414c52454144595f415554484f52495a454400000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8116600081815260016020819052604080832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00168317905560028054928301815583527f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace90910180547fffffffffffffffffffffffff00000000000000000000000000000000000000001684179055513392917f3147867c59d17e8fa9d522465651d44aae0a9e38f902f3475b97e58072f0ed4c91a350565b6002818154811061055057fe5b60009182526020909120015473ffffffffffffffffffffffffffffffffffffffff16905081565b60005473ffffffffffffffffffffffffffffffffffffffff1633146105fd57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff811660009081526001602052604090205460ff1661069157604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f5441524745545f4e4f545f415554484f52495a45440000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8116600090815260016020526040812080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001690555b600254811015610823578173ffffffffffffffffffffffffffffffffffffffff166002828154811061070b57fe5b60009182526020909120015473ffffffffffffffffffffffffffffffffffffffff16141561081b57600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff810190811061076357fe5b6000918252602090912001546002805473ffffffffffffffffffffffffffffffffffffffff909216918390811061079657fe5b600091825260209091200180547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff01906108159082611407565b50610823565b6001016106dd565b50604051339073ffffffffffffffffffffffffffffffffffffffff8316907f1f32c1b084e2de0713b8fb16bd46bb9df710a3dbeae2f3ca93af46e016dcc6b090600090a350565b60005473ffffffffffffffffffffffffffffffffffffffff1681565b60005473ffffffffffffffffffffffffffffffffffffffff16331461090c57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff821660009081526001602052604090205460ff166109a057604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f5441524745545f4e4f545f415554484f52495a45440000000000000000000000604482015290519081900360640190fd5b6002548110610a1057604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f494e4445585f4f55545f4f465f424f554e445300000000000000000000000000604482015290519081900360640190fd5b8173ffffffffffffffffffffffffffffffffffffffff1660028281548110610a3457fe5b60009182526020909120015473ffffffffffffffffffffffffffffffffffffffff1614610ac257604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601b60248201527f415554484f52495a45445f414444524553535f4d49534d415443480000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8216600090815260016020526040902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00169055600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8101908110610b3d57fe5b6000918252602090912001546002805473ffffffffffffffffffffffffffffffffffffffff9092169183908110610b7057fe5b600091825260209091200180547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190610bef9082611407565b50604051339073ffffffffffffffffffffffffffffffffffffffff8416907f1f32c1b084e2de0713b8fb16bd46bb9df710a3dbeae2f3ca93af46e016dcc6b090600090a35050565b3360009081526001602052604090205460ff16610cb557604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f53454e4445525f4e4f545f415554484f52495a45440000000000000000000000604482015290519081900360640190fd5b60006060806060610d0b60048a8a90508b8b8080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525092949392505063ffffffff6112c3169050565b8060200190516080811015610d1f57600080fd5b815160208301805160405192949293830192919084640100000000821115610d4657600080fd5b908301906020820185811115610d5b57600080fd5b8251866020820283011164010000000082111715610d7857600080fd5b82525081516020918201928201910280838360005b83811015610da5578181015183820152602001610d8d565b5050505090500160405260200180516040519392919084640100000000821115610dce57600080fd5b908301906020820185811115610de357600080fd5b8251866020820283011164010000000082111715610e0057600080fd5b82525081516020918201928201910280838360005b83811015610e2d578181015183820152602001610e15565b5050505090500160405260200180516040519392919084640100000000821115610e5657600080fd5b908301906020820185811115610e6b57600080fd5b8251640100000000811182820188101715610e8557600080fd5b82525081516020918201929091019080838360005b83811015610eb2578181015183820152602001610e9a565b50505050905090810190601f168015610edf5780820380516001836020036101000a031916815260200191505b506040525050509350935093509350600082519050606081604051908082528060200260200182016040528015610f20578160200160208202803883390190505b50905060005b828114610f6957610f4a858281518110610f3c57fe5b602002602001015189611306565b828281518110610f5657fe5b6020908102919091010152600101610f26565b508573ffffffffffffffffffffffffffffffffffffffff16632eb2c2d68a8a8885886040518663ffffffff1660e01b8152600401808673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020018573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff168152602001806020018060200180602001848103845287818151815260200191508051906020019060200280838360005b8381101561104657818101518382015260200161102e565b50505050905001848103835286818151815260200191508051906020019060200280838360005b8381101561108557818101518382015260200161106d565b50505050905001848103825285818151815260200191508051906020019080838360005b838110156110c15781810151838201526020016110a9565b50505050905090810190601f1680156110ee5780820380516001836020036101000a031916815260200191505b5098505050505050505050600060405180830381600087803b15801561111357600080fd5b505af1158015611127573d6000803e3d6000fd5b505050505050505050505050505050565b6000604051808061144f603091396030019050604051809103902090505b90565b60016020526000908152604090205460ff1681565b606060028054806020026020016040519081016040528092919081815260200182805480156111d357602002820191906000526020600020905b815473ffffffffffffffffffffffffffffffffffffffff1681526001909101906020018083116111a8575b5050505050905090565b60005473ffffffffffffffffffffffffffffffffffffffff16331461126357604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8116156112c057600080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff83161790555b50565b6060818311156112e1576112e16112dc60008585611340565b6113df565b83518211156112fa576112fa6112dc6001848751611340565b50819003910190815290565b6000826113155750600061133a565b8282028284828161132257fe5b0414611337576113376112dc600186866113e7565b90505b92915050565b6060632800659560e01b8484846040516024018084600781111561136057fe5b60ff1681526020018381526020018281526020019350505050604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff838183161783525050505090509392505050565b805160208201fd5b606063e946c1bb60e01b8484846040516024018084600381111561136057fe5b81548183558181111561142b5760008381526020902061142b918101908301611430565b505050565b61115691905b8082111561144a5760008155600101611436565b509056fe4552433131353541737365747328616464726573732c75696e743235365b5d2c75696e743235365b5d2c627974657329a265627a7a72315820be5e6597d38133fd52aac17250498790f106d5d4d0e4ab30d0e854a2db1e2ffe64736f6c634300050c0032" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L51)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC1155ProxyEvents](#enumeration-erc1155proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1771](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1771)* + +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:1729](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1729)* + +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:1754](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1754)* + +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:1760](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1760)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1513](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1513)* + +**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:1471](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1471)* + +**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:1446](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1446)* + +**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:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L56)* + +Authorizes an address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.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 | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L148)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`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:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L118)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L217)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:205](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L205)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L192)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:64](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L64)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L137)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### authorities + +#### ▪ **authorities**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:225](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L225)* + +#### callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:231](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L231)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:301](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L301)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L289)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:278](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L278)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### authorized + +#### ▪ **authorized**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:309](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L309)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:315](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L315)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:387](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L387)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:375](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L375)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:362](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L362)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getAuthorizedAddresses + +#### ▪ **getAuthorizedAddresses**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L398)* + +Gets all authorized addresses. + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:405](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L405)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +Array of authorized addresses. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:469](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L469)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:457](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L457)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:447](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L447)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getProxyId + +#### ▪ **getProxyId**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L480)* + +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:487](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L487)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +Proxy id. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:543](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L543)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:531](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L531)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:521](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L521)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### owner + +#### ▪ **owner**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:551](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L551)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:557](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L557)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:621](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L621)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:609](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L609)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:599](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L599)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### removeAuthorizedAddress + +#### ▪ **removeAuthorizedAddress**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:632](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L632)* + +Removes authorizion of an address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:667](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L667)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:724](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. | +`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:694](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L694)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:793](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L793)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:781](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L781)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:768](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.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). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:640](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L640)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:713](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L713)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### removeAuthorizedAddressAtIndex + +#### ▪ **removeAuthorizedAddressAtIndex**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:804](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L804)* + +Removes authorizion of an address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:849](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L849)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`target`: string, `index`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:930](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L930)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:883](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L883)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1011](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1011)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:999](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L999)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:984](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L984)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:813](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:910](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L910)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`index` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1022](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1022)* + +Transfers batch of ERC1155 assets. Either succeeds or throws. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1081](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1081)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | +`from` | string | Address to transfer assets from. | +`to` | string | Address to transfer assets to. | +`amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1180](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1180)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1125](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1125)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | +`from` | string | Address to transfer assets from. | +`to` | string | Address to transfer assets to. | +`amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1273](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1273)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1261](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1261)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1244](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1244)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | +`from` | string | Address to transfer assets from. | +`to` | string | Address to transfer assets to. | +`amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1035](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1035)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | +`from` | string | Address to transfer assets from. | +`to` | string | Address to transfer assets to. | +`amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1158](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1158)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetData` | string | +`from` | string | +`to` | string | +`amount` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferOwnership + +#### ▪ **transferOwnership**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1281](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1281)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1314](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1314)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1369](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1369)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1340)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1437](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1437)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1425](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1425)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1412](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1412)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1288](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1288)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1359](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1359)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ERC20ProxyContract + + +## Constructors + + + +\+ **new ERC20ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20ProxyContract](#class-erc20proxycontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1506](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1506)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC20ProxyContract.deployedBytecode | + +**Returns:** *[ERC20ProxyContract](#class-erc20proxycontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b50600436106100a35760003560e01c80639ad2674411610076578063b91816111161005b578063b918161114610374578063d39de6e9146103bb578063f2fde38b14610413576100a3565b80639ad26744146102fe578063ae25532e14610337576100a3565b806342f1181e14610248578063494503d41461027d57806370712939146102c35780638da5cb5b146102f6575b7fffffffff00000000000000000000000000000000000000000000000000000000600035167fa85e59e40000000000000000000000000000000000000000000000000000000081141561024257604080513381526001602082015290812054610177577f08c379a0000000000000000000000000000000000000000000000000000000006000527c20000000000000000000000000000000000000000000000000000000006020527c1553454e4445525f4e4f545f415554484f52495a454400000000000000604052600060605260646000fd5b50602860043501357f23b872dd0000000000000000000000000000000000000000000000000000000060005260606024600437602060006064600080855af1600080511160203d14163d15178116905080156101cf57005b50507f08c379a0000000000000000000000000000000000000000000000000000000006000527c20000000000000000000000000000000000000000000000000000000006020527c0f5452414e534645525f4641494c454400000000000000000000000000604052600060605260646000fd5b50600080fd5b61027b6004803603602081101561025e57600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610446565b005b61029a6004803603602081101561029357600080fd5b5035610632565b6040805173ffffffffffffffffffffffffffffffffffffffff9092168252519081900360200190f35b61027b600480360360208110156102d957600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610666565b61029a610959565b61027b6004803603604081101561031457600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135169060200135610975565b61033f610d26565b604080517fffffffff000000000000000000000000000000000000000000000000000000009092168252519081900360200190f35b6103a76004803603602081101561038a57600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610d5c565b604080519115158252519081900360200190f35b6103c3610d71565b60408051602080825283518183015283519192839290830191858101910280838360005b838110156103ff5781810151838201526020016103e7565b505050509050019250505060405180910390f35b61027b6004803603602081101561042957600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610de0565b60005473ffffffffffffffffffffffffffffffffffffffff1633146104cc57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff811660009081526001602052604090205460ff161561056157604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601960248201527f5441524745545f414c52454144595f415554484f52495a454400000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8116600081815260016020819052604080832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00168317905560028054928301815583527f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace90910180547fffffffffffffffffffffffff00000000000000000000000000000000000000001684179055513392917f3147867c59d17e8fa9d522465651d44aae0a9e38f902f3475b97e58072f0ed4c91a350565b6002818154811061063f57fe5b60009182526020909120015473ffffffffffffffffffffffffffffffffffffffff16905081565b60005473ffffffffffffffffffffffffffffffffffffffff1633146106ec57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff811660009081526001602052604090205460ff1661078057604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f5441524745545f4e4f545f415554484f52495a45440000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8116600090815260016020526040812080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001690555b600254811015610912578173ffffffffffffffffffffffffffffffffffffffff16600282815481106107fa57fe5b60009182526020909120015473ffffffffffffffffffffffffffffffffffffffff16141561090a57600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff810190811061085257fe5b6000918252602090912001546002805473ffffffffffffffffffffffffffffffffffffffff909216918390811061088557fe5b600091825260209091200180547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff01906109049082610ec6565b50610912565b6001016107cc565b50604051339073ffffffffffffffffffffffffffffffffffffffff8316907f1f32c1b084e2de0713b8fb16bd46bb9df710a3dbeae2f3ca93af46e016dcc6b090600090a350565b60005473ffffffffffffffffffffffffffffffffffffffff1681565b60005473ffffffffffffffffffffffffffffffffffffffff1633146109fb57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff821660009081526001602052604090205460ff16610a8f57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f5441524745545f4e4f545f415554484f52495a45440000000000000000000000604482015290519081900360640190fd5b6002548110610aff57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f494e4445585f4f55545f4f465f424f554e445300000000000000000000000000604482015290519081900360640190fd5b8173ffffffffffffffffffffffffffffffffffffffff1660028281548110610b2357fe5b60009182526020909120015473ffffffffffffffffffffffffffffffffffffffff1614610bb157604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601b60248201527f415554484f52495a45445f414444524553535f4d49534d415443480000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8216600090815260016020526040902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00169055600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8101908110610c2c57fe5b6000918252602090912001546002805473ffffffffffffffffffffffffffffffffffffffff9092169183908110610c5f57fe5b600091825260209091200180547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190610cde9082610ec6565b50604051339073ffffffffffffffffffffffffffffffffffffffff8416907f1f32c1b084e2de0713b8fb16bd46bb9df710a3dbeae2f3ca93af46e016dcc6b090600090a35050565b604080517f4552433230546f6b656e28616464726573732900000000000000000000000000815290519081900360130190205b90565b60016020526000908152604090205460ff1681565b60606002805480602002602001604051908101604052809291908181526020018280548015610dd657602002820191906000526020600020905b815473ffffffffffffffffffffffffffffffffffffffff168152600190910190602001808311610dab575b5050505050905090565b60005473ffffffffffffffffffffffffffffffffffffffff163314610e6657604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff811615610ec357600080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff83161790555b50565b815481835581811115610eea57600083815260209020610eea918101908301610eef565b505050565b610d5991905b80821115610f095760008155600101610ef5565b509056fea265627a7a72315820cb3312567959522bd12ea03b9812cab2bace85fe5f172b3ae8014b3eacc85fa864736f6c634300050b0032" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L51)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#enumeration-erc20proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1490](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1490)* + +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:1448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1448)* + +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:1473](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1473)* + +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:1479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1479)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1251](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1251)* + +**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:1209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1209)* + +**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:1184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1184)* + +**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:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L56)* + +Authorizes an address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.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 | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L148)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`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:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L118)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L217)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:205](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L205)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L192)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:64](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L64)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L137)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### authorities + +#### ▪ **authorities**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:225](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L225)* + +#### callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:231](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L231)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:301](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L301)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L289)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:278](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L278)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### authorized + +#### ▪ **authorized**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:851](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L851)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:857](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L857)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:929](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L929)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:917](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L917)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:904](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L904)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getAuthorizedAddresses + +#### ▪ **getAuthorizedAddresses**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:940](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L940)* + +Gets all authorized addresses. + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:947](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L947)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +Array of authorized addresses. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1011](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1011)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:999](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L999)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:989](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L989)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getProxyId + +#### ▪ **getProxyId**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:780](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L780)* + +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:787](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L787)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +Proxy id. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:843](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L843)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:831](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L831)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:821](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L821)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### owner + +#### ▪ **owner**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:481](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L481)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:487](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L487)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:551](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L551)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:539](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L539)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:529](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L529)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### removeAuthorizedAddress + +#### ▪ **removeAuthorizedAddress**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:312](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L312)* + +Removes authorizion of an address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:347](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L347)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:404](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L404)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:374](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L374)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:473](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L473)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:461](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L461)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L448)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:320](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L320)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L393)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### removeAuthorizedAddressAtIndex + +#### ▪ **removeAuthorizedAddressAtIndex**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:562](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L562)* + +Removes authorizion of an address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:607](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L607)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`target`: string, `index`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L688)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L641)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:769](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L769)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:757](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L757)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:742](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L742)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:571](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L571)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:668](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L668)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`index` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferOwnership + +#### ▪ **transferOwnership**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1019](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1019)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1052](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1052)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1107](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1107)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`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:1078](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1078)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1175](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1175)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1163](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1163)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1150](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1150)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1026](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1026)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1097](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1097)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ERC20TokenContract + + +## Constructors + + + +\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20TokenContract](#class-erc20tokencontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1282](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1282)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC20TokenContract.deployedBytecode | + +**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b50600436106100725760003560e01c806370a082311161005057806370a0823114610121578063a9059cbb14610154578063dd62ed3e1461018d57610072565b8063095ea7b31461007757806318160ddd146100c457806323b872dd146100de575b600080fd5b6100b06004803603604081101561008d57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81351690602001356101c8565b604080519115158252519081900360200190f35b6100cc61023b565b60408051918252519081900360200190f35b6100b0600480360360608110156100f457600080fd5b5073ffffffffffffffffffffffffffffffffffffffff813581169160208101359091169060400135610241565b6100cc6004803603602081101561013757600080fd5b503573ffffffffffffffffffffffffffffffffffffffff1661049d565b6100b06004803603604081101561016a57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81351690602001356104c5565b6100cc600480360360408110156101a357600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81358116916020013516610652565b33600081815260016020908152604080832073ffffffffffffffffffffffffffffffffffffffff8716808552908352818420869055815186815291519394909390927f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925928290030190a350600192915050565b60025490565b73ffffffffffffffffffffffffffffffffffffffff83166000908152602081905260408120548211156102d557604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601a60248201527f45524332305f494e53554646494349454e545f42414c414e4345000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8416600090815260016020908152604080832033845290915290205482111561037457604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601c60248201527f45524332305f494e53554646494349454e545f414c4c4f57414e434500000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8316600090815260208190526040902054828101101561040a57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601060248201527f55494e543235365f4f564552464c4f5700000000000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff80841660008181526020818152604080832080548801905593881680835284832080548890039055600182528483203384528252918490208054879003905583518681529351929391927fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9281900390910190a35060019392505050565b73ffffffffffffffffffffffffffffffffffffffff1660009081526020819052604090205490565b3360009081526020819052604081205482111561054357604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601a60248201527f45524332305f494e53554646494349454e545f42414c414e4345000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff831660009081526020819052604090205482810110156105d957604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601060248201527f55494e543235365f4f564552464c4f5700000000000000000000000000000000604482015290519081900360640190fd5b336000818152602081815260408083208054879003905573ffffffffffffffffffffffffffffffffffffffff871680845292819020805487019055805186815290519293927fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef929181900390910190a350600192915050565b73ffffffffffffffffffffffffffffffffffffffff91821660009081526001602090815260408083209390941682529190915220549056fea265627a7a723158205713efa92f66e67a8d01b80af8500df66bd6e9862dcf791e587181109d8ab0c464736f6c634300050b0032" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L51)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1266](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1266)* + +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:1224](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1224)* + +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:1249](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1249)* + +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:1255](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1255)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1035](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1035)* + +**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:993](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L993)* + +**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:968](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L968)* + +**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:869](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L869)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:878](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.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 | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address of the account owning tokens | +`_spender` | string | - | The address of the account able to transfer the tokens | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Amount of remaining tokens allowed to spent + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:959](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L959)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:947](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L947)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:932](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L932)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address of the account owning tokens | +`_spender` | string | The address of the account able to transfer the tokens | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### approve + +#### ▪ **approve**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L56)* + +`msg.sender` approves `_spender` to spend `_value` tokens + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:101](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L101)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:175](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L175)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L131)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L256)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:244](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L244)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L229)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:65](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L65)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:158](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L158)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:584](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L584)* + +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:592](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L592)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address from which the balance will be retrieved | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Balance of owner + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:663](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L663)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L651)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:640](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L640)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address from which the balance will be retrieved | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### totalSupply + +#### ▪ **totalSupply**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:267](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L267)* + +Query total supply of token + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:274](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L274)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +Total supply of token + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:338](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L338)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:326](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L326)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:316](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L316)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transfer + +#### ▪ **transfer**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L674)* + +send `value` token to `to` from `msg.sender` + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:716](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L716)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:783](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L783)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_to` | string | - | 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:746](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L746)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:861](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L861)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:849](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L849)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:834](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L834)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:683](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L683)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:766](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L766)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L349)* + +send `value` token to `to` from `from` on the condition it is approved by `from` + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:399](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L399)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The address of the sender | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:486](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L486)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:437](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L437)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The address of the sender | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:573](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L573)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L561)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:544](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L544)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The address of the sender | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:359](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L359)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The address of the sender | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:467](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L467)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ERC721ProxyContract + + +## Constructors + + + +\+ **new ERC721ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC721ProxyContract](#class-erc721proxycontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1506](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1506)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC721ProxyContract.deployedBytecode | + +**Returns:** *[ERC721ProxyContract](#class-erc721proxycontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b50600436106100a35760003560e01c80639ad2674411610076578063b91816111161005b578063b9181611146103ea578063d39de6e914610431578063f2fde38b14610489576100a3565b80639ad2674414610374578063ae25532e146103ad576100a3565b806342f1181e146102be578063494503d4146102f357806370712939146103395780638da5cb5b1461036c575b7fffffffff00000000000000000000000000000000000000000000000000000000600035167fa85e59e4000000000000000000000000000000000000000000000000000000008114156102b857604080513381526001602082015290812054610177577f08c379a0000000000000000000000000000000000000000000000000000000006000527c20000000000000000000000000000000000000000000000000000000006020527c1553454e4445525f4e4f545f415554484f52495a454400000000000000604052600060605260646000fd5b50600160643503156101f4577f08c379a0000000000000000000000000000000000000000000000000000000006000527c20000000000000000000000000000000000000000000000000000000006020527c0e494e56414c49445f414d4f554e540000000000000000000000000000604052600060605260646000fd5b7f23b872dd000000000000000000000000000000000000000000000000000000006000526040602460043760043560206048820160443760288101356000806064600080855af1915050801561024657005b507f08c379a0000000000000000000000000000000000000000000000000000000006000527c20000000000000000000000000000000000000000000000000000000006020527c0f5452414e534645525f4641494c454400000000000000000000000000604052600060605260646000fd5b50600080fd5b6102f1600480360360208110156102d457600080fd5b503573ffffffffffffffffffffffffffffffffffffffff166104bc565b005b6103106004803603602081101561030957600080fd5b50356106a8565b6040805173ffffffffffffffffffffffffffffffffffffffff9092168252519081900360200190f35b6102f16004803603602081101561034f57600080fd5b503573ffffffffffffffffffffffffffffffffffffffff166106dc565b6103106109cf565b6102f16004803603604081101561038a57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81351690602001356109eb565b6103b5610d9c565b604080517fffffffff000000000000000000000000000000000000000000000000000000009092168252519081900360200190f35b61041d6004803603602081101561040057600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610dd2565b604080519115158252519081900360200190f35b610439610de7565b60408051602080825283518183015283519192839290830191858101910280838360005b8381101561047557818101518382015260200161045d565b505050509050019250505060405180910390f35b6102f16004803603602081101561049f57600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610e56565b60005473ffffffffffffffffffffffffffffffffffffffff16331461054257604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff811660009081526001602052604090205460ff16156105d757604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601960248201527f5441524745545f414c52454144595f415554484f52495a454400000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8116600081815260016020819052604080832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00168317905560028054928301815583527f405787fa12a823e0f2b7631cc41b3ba8828b3321ca811111fa75cd3aa3bb5ace90910180547fffffffffffffffffffffffff00000000000000000000000000000000000000001684179055513392917f3147867c59d17e8fa9d522465651d44aae0a9e38f902f3475b97e58072f0ed4c91a350565b600281815481106106b557fe5b60009182526020909120015473ffffffffffffffffffffffffffffffffffffffff16905081565b60005473ffffffffffffffffffffffffffffffffffffffff16331461076257604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff811660009081526001602052604090205460ff166107f657604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f5441524745545f4e4f545f415554484f52495a45440000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8116600090815260016020526040812080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001690555b600254811015610988578173ffffffffffffffffffffffffffffffffffffffff166002828154811061087057fe5b60009182526020909120015473ffffffffffffffffffffffffffffffffffffffff16141561098057600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff81019081106108c857fe5b6000918252602090912001546002805473ffffffffffffffffffffffffffffffffffffffff90921691839081106108fb57fe5b600091825260209091200180547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff019061097a9082610f3c565b50610988565b600101610842565b50604051339073ffffffffffffffffffffffffffffffffffffffff8316907f1f32c1b084e2de0713b8fb16bd46bb9df710a3dbeae2f3ca93af46e016dcc6b090600090a350565b60005473ffffffffffffffffffffffffffffffffffffffff1681565b60005473ffffffffffffffffffffffffffffffffffffffff163314610a7157604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff821660009081526001602052604090205460ff16610b0557604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f5441524745545f4e4f545f415554484f52495a45440000000000000000000000604482015290519081900360640190fd5b6002548110610b7557604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f494e4445585f4f55545f4f465f424f554e445300000000000000000000000000604482015290519081900360640190fd5b8173ffffffffffffffffffffffffffffffffffffffff1660028281548110610b9957fe5b60009182526020909120015473ffffffffffffffffffffffffffffffffffffffff1614610c2757604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601b60248201527f415554484f52495a45445f414444524553535f4d49534d415443480000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8216600090815260016020526040902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00169055600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8101908110610ca257fe5b6000918252602090912001546002805473ffffffffffffffffffffffffffffffffffffffff9092169183908110610cd557fe5b600091825260209091200180547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055600280547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190610d549082610f3c565b50604051339073ffffffffffffffffffffffffffffffffffffffff8416907f1f32c1b084e2de0713b8fb16bd46bb9df710a3dbeae2f3ca93af46e016dcc6b090600090a35050565b604080517f455243373231546f6b656e28616464726573732c75696e7432353629000000008152905190819003601c0190205b90565b60016020526000908152604090205460ff1681565b60606002805480602002602001604051908101604052809291908181526020018280548015610e4c57602002820191906000526020600020905b815473ffffffffffffffffffffffffffffffffffffffff168152600190910190602001808311610e21575b5050505050905090565b60005473ffffffffffffffffffffffffffffffffffffffff163314610edc57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f4f4e4c595f434f4e54524143545f4f574e455200000000000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff811615610f3957600080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff83161790555b50565b815481835581811115610f6057600083815260209020610f60918101908301610f65565b505050565b610dcf91905b80821115610f7f5760008155600101610f6b565b509056fea265627a7a723158201e53a891f6df3931041b820f71387e9eecd97f7ea0d346c54fab37668bd022ec64736f6c634300050b0032" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L51)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721ProxyEvents](#enumeration-erc721proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1490](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1490)* + +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:1448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1448)* + +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:1473](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1473)* + +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:1479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1479)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1251](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1251)* + +**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:1209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1209)* + +**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:1184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1184)* + +**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:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L56)* + +Authorizes an address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.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 | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L148)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`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:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L118)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L217)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:205](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L205)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L192)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:64](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L64)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L137)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### authorities + +#### ▪ **authorities**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:225](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L225)* + +#### callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:231](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L231)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:301](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L301)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L289)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:278](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L278)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### authorized + +#### ▪ **authorized**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:851](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L851)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:857](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L857)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:929](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L929)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:917](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L917)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:904](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L904)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getAuthorizedAddresses + +#### ▪ **getAuthorizedAddresses**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:940](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L940)* + +Gets all authorized addresses. + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:947](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L947)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +Array of authorized addresses. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1011](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1011)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:999](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L999)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:989](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L989)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getProxyId + +#### ▪ **getProxyId**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:780](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L780)* + +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:787](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L787)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +Proxy id. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:843](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L843)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:831](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L831)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:821](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L821)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### owner + +#### ▪ **owner**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:481](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L481)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:487](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L487)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:551](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L551)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:539](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L539)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:529](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L529)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### removeAuthorizedAddress + +#### ▪ **removeAuthorizedAddress**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:312](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L312)* + +Removes authorizion of an address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:347](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L347)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:404](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L404)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:374](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L374)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:473](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L473)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:461](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L461)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L448)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:320](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L320)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L393)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### removeAuthorizedAddressAtIndex + +#### ▪ **removeAuthorizedAddressAtIndex**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:562](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L562)* + +Removes authorizion of an address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:607](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L607)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`target`: string, `index`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L688)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L641)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:769](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L769)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:757](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L757)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:742](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L742)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:571](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L571)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:668](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L668)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`index` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferOwnership + +#### ▪ **transferOwnership**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1019](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1019)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1052](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1052)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1107](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1107)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`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:1078](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1078)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1175](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1175)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1163](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1163)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1150](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1150)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1026](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1026)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1097](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1097)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ERC721TokenContract + + +## Constructors + + + +\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC721TokenContract](#class-erc721tokencontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1991](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1991)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC721TokenContract.deployedBytecode | + +**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x608060405234801561001057600080fd5b50600436106100a35760003560e01c80636352211e11610076578063a22cb4651161005b578063a22cb46514610211578063b88d4fde1461024c578063e985e9c5146102e9576100a3565b80636352211e146101af57806370a08231146101cc576100a3565b8063081812fc146100a8578063095ea7b3146100ee57806323b872dd1461012957806342842e0e1461016c575b600080fd5b6100c5600480360360208110156100be57600080fd5b5035610338565b6040805173ffffffffffffffffffffffffffffffffffffffff9092168252519081900360200190f35b6101276004803603604081101561010457600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135169060200135610360565b005b6101276004803603606081101561013f57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff813581169160208101359091169060400135610482565b6101276004803603606081101561018257600080fd5b5073ffffffffffffffffffffffffffffffffffffffff8135811691602081013590911690604001356107ef565b6100c5600480360360208110156101c557600080fd5b5035610989565b6101ff600480360360208110156101e257600080fd5b503573ffffffffffffffffffffffffffffffffffffffff16610a20565b60408051918252519081900360200190f35b6101276004803603604081101561022757600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81351690602001351515610acd565b6101276004803603608081101561026257600080fd5b73ffffffffffffffffffffffffffffffffffffffff8235811692602081013590911691604082013591908101906080810160608201356401000000008111156102aa57600080fd5b8201836020820111156102bc57600080fd5b803590602001918460018302840111640100000000831117156102de57600080fd5b509092509050610b66565b610324600480360360408110156102ff57600080fd5b5073ffffffffffffffffffffffffffffffffffffffff81358116916020013516610d31565b604080519115158252519081900360200190f35b60009081526001602052604090205473ffffffffffffffffffffffffffffffffffffffff1690565b600061036b82610989565b90503373ffffffffffffffffffffffffffffffffffffffff8216148061039657506103968133610d31565b61040157604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f4552433732315f494e56414c49445f53454e4445520000000000000000000000604482015290519081900360640190fd5b60008281526001602052604080822080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff87811691821790925591518593918516917f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92591a4505050565b73ffffffffffffffffffffffffffffffffffffffff821661050457604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601660248201527f4552433732315f5a45524f5f544f5f4144445245535300000000000000000000604482015290519081900360640190fd5b600061050f82610989565b90508073ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff16146105ab57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601560248201527f4552433732315f4f574e45525f4d49534d415443480000000000000000000000604482015290519081900360640190fd5b3360006105b784610338565b90508273ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1614806105f857506105f88383610d31565b8061062e57508173ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16145b61069957604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601660248201527f4552433732315f494e56414c49445f5350454e44455200000000000000000000604482015290519081900360640190fd5b73ffffffffffffffffffffffffffffffffffffffff8116156106ea57600084815260016020526040902080547fffffffffffffffffffffffff00000000000000000000000000000000000000001690555b60008481526020818152604080832080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff8a811691909117909155891683526002909152902054610753906001610d6c565b73ffffffffffffffffffffffffffffffffffffffff8088166000908152600260205260408082209390935590871681522054610790906001610d90565b73ffffffffffffffffffffffffffffffffffffffff808716600081815260026020526040808220949094559251879391928a16917fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef91a4505050505050565b6107fa838383610482565b813b801561098357604080517f150b7a0200000000000000000000000000000000000000000000000000000000815233600482015273ffffffffffffffffffffffffffffffffffffffff8681166024830152604482018590526080606483015260006084830181905292519086169163150b7a029160c480830192602092919082900301818787803b15801561088f57600080fd5b505af11580156108a3573d6000803e3d6000fd5b505050506040513d60208110156108b957600080fd5b505160405190915080602f610e5b8239602f01905060405180910390207bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19161461098157604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4552433732315f494e56414c49445f53454c4543544f52000000000000000000604482015290519081900360640190fd5b505b50505050565b60008181526020819052604081205473ffffffffffffffffffffffffffffffffffffffff1680610a1a57604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601160248201527f4552433732315f5a45524f5f4f574e4552000000000000000000000000000000604482015290519081900360640190fd5b92915050565b600073ffffffffffffffffffffffffffffffffffffffff8216610aa457604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601160248201527f4552433732315f5a45524f5f4f574e4552000000000000000000000000000000604482015290519081900360640190fd5b5073ffffffffffffffffffffffffffffffffffffffff1660009081526002602052604090205490565b33600081815260036020908152604080832073ffffffffffffffffffffffffffffffffffffffff87168085529083529281902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016861515908117909155815190815290519293927f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31929181900390910190a35050565b610b71858585610482565b833b8015610d29576040517f150b7a02000000000000000000000000000000000000000000000000000000008152336004820181815273ffffffffffffffffffffffffffffffffffffffff89811660248501526044840188905260806064850190815260848501879052600094918a169363150b7a029390928c928b928b928b929060a401848480828437600081840152601f19601f8201169050808301925050509650505050505050602060405180830381600087803b158015610c3557600080fd5b505af1158015610c49573d6000803e3d6000fd5b505050506040513d6020811015610c5f57600080fd5b505160405190915080602f610e5b8239602f01905060405180910390207bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614610d2757604080517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4552433732315f494e56414c49445f53454c4543544f52000000000000000000604482015290519081900360640190fd5b505b505050505050565b73ffffffffffffffffffffffffffffffffffffffff918216600090815260036020908152604080832093909416825291909152205460ff1690565b600082821115610d8a57610d8a610d8560028585610db3565b610e52565b50900390565b600082820183811015610dac57610dac610d8560008686610db3565b9392505050565b606063e946c1bb60e01b84848460405160240180846003811115610dd357fe5b60ff1681526020018381526020018281526020019350505050604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff838183161783525050505090509392505050565b805160208201fdfe6f6e455243373231526563656976656428616464726573732c616464726573732c75696e743235362c627974657329a265627a7a723158204bc74831490bca4fbe1805808d58d6b0e12f618a37565e744e91d8dc73dc18b164736f6c634300050c0032" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L61)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1975](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1975)* + +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:1933](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1933)* + +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:1958](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1958)* + +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:1964](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1964)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1664](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1664)* + +**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:1622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1622)* + +**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:1597](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1597)* + +**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:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L68)* + +The zero address indicates there is no approved address. +Throws unless `msg.sender` is the current NFT owner, or an authorized +operator of the current owner. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:113](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L113)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L186)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:143](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L143)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:267](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L267)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:255](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L255)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:240](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L240)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:77](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L77)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L170)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_approved` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:279](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L279)* + +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:287](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L287)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | An address for whom to query the balance | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The number of NFTs owned by `_owner`, possibly zero + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L358)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:346](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L346)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L335)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | An address for whom to query the balance | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getApproved + +#### ▪ **getApproved**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:369](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L369)* + +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:377](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L377)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_tokenId` | `BigNumber` | - | The NFT to find the approved address for | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The approved address for this NFT, or the zero address if there is none + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L448)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L436)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:425](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L425)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The NFT to find the approved address for | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### isApprovedForAll + +#### ▪ **isApprovedForAll**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:456](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L456)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:465](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L465)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address that owns the NFTs | +`_operator` | string | - | The address that acts on behalf of the owner | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +True if `_operator` is an approved operator for `_owner`, false otherwise + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:546](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L546)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:534](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L534)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:519](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L519)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address that owns the NFTs | +`_operator` | string | The address that acts on behalf of the owner | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### ownerOf + +#### ▪ **ownerOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:558](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L558)* + +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:566](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L566)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_tokenId` | `BigNumber` | - | The identifier for an NFT | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The address of the owner of the NFT + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:637](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L637)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:625](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L625)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`BigNumber`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:614](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L614)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The identifier for an NFT | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### safeTransferFrom1 + +#### ▪ **safeTransferFrom1**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:649](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L649)* + +This works identically to the other function with an extra data parameter, +except this function just sets data to "". + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:699](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L699)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:785](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L785)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | 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:737](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L737)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:872](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L872)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:860](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L860)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:843](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L843)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:659](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L659)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:767](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L767)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### safeTransferFrom2 + +#### ▪ **safeTransferFrom2**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:889](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L889)* + +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. When transfer is complete, this function +checks if `_to` is a smart contract (code size > 0). If so, it calls +`onERC721Received` on `_to` and throws if the return value is not +`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:944](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L944)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1045](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1045)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:986](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L986)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1136)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1124](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1124)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, `BigNumber`, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1107](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1107)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:900](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L900)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`_data` | string | Additional data with no specified format, sent in call to `_to` | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1019](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1019)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`_data` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### setApprovalForAll + +#### ▪ **setApprovalForAll**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1148)* + +Emits the ApprovalForAll event. The contract MUST allow +multiple operators per owner. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1193](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1193)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_operator`: string, `_approved`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1270](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1270)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1227](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1227)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1351](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1351)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1339](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1339)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, boolean]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1324](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1324)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1157](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1157)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1254](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1254)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_operator` | string | +`_approved` | boolean | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1365](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1365)* + +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1415](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1415)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1501](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1501)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1453](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1453)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1588](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1588)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1576](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1576)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1559](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1559)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1375](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1375)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1483)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ExchangeContract + + +## Constructors + + + +\+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ExchangeContract](#class-exchangecontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:13414](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13414)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ExchangeContract.deployedBytecode | + +**Returns:** *[ExchangeContract](#class-exchangecontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x6080604052600436106102d15760003560e01c80638da5cb5b11610179578063beee2e14116100d6578063dd885e2d1161008a578063eea086ba11610064578063eea086ba14610715578063f2fde38b1461072a578063fc74896d1461074a576102d1565b8063dd885e2d146106cd578063dedfc1f1146106ef578063e14b58c414610702576102d1565b8063c26cfecd116100bb578063c26cfecd14610678578063c585bb931461068d578063d9bfa73e146106ad576102d1565b8063beee2e1414610645578063c0fa16cc14610658576102d1565b80639d3fa4b91161012d578063a6c3bf3311610112578063a6c3bf33146105ff578063b04fbddd14610612578063b718e29214610632576102d1565b80639d3fa4b9146105b2578063a12dcc6f146105df576102d1565b80639331c7421161015e5780639331c7421461056c5780639694a4021461058c5780639b44d5561461059f576102d1565b80638da5cb5b146105375780638ea8dfe41461054c576102d1565b80636a1a80fd116102325780638171c407116101e657806388ec79fb116101c057806388ec79fb146104e45780638bc8efb3146105045780638d45cd2314610517576102d1565b80638171c4071461048f57806382c174d0146104af578063850a1501146104cf576102d1565b806377fcce681161021757806377fcce681461044957806378d29ac11461045c5780637b8e35141461046f576102d1565b80636a1a80fd146104165780636fcf3e9e14610436576102d1565b80632da629871161028957806346c02d7a1161026e57806346c02d7a146103c35780634f9559b1146103d657806360704108146103e9576102d1565b80632da629871461038e578063369da099146103a3576102d1565b80632280c910116102ba5780632280c9101461032e578063288cdc911461034e5780632ac126221461036e576102d1565b80630228e168146102d65780631ce4c78b1461030c575b600080fd5b3480156102e257600080fd5b506102f66102f1366004614e64565b61076a565b60405161030391906154c4565b60405180910390f35b34801561031857600080fd5b5061032161077f565b60405161030391906154cf565b61034161033c366004615108565b610785565b60405161030391906156a0565b34801561035a57600080fd5b50610321610369366004614e64565b6107c7565b34801561037a57600080fd5b506102f6610389366004614e64565b6107d9565b6103a161039c366004614f82565b6107ee565b005b6103b66103b1366004614d60565b610812565b60405161030391906159c2565b6103a16103d1366004614e64565b610939565b6103a16103e4366004614e64565b6109ac565b3480156103f557600080fd5b50610409610404366004614eed565b610ab9565b604051610303919061535b565b610429610424366004614c40565b610b07565b604051610303919061594b565b610429610444366004614c40565b610b3f565b6103a1610457366004614b2a565b610b5d565b6103b661046a366004614d60565b610c20565b34801561047b57600080fd5b506102f661048a366004614af6565b610d70565b34801561049b57600080fd5b506102f66104aa366004614ea0565b610d90565b3480156104bb57600080fd5b506102f66104ca366004614e7c565b610def565b3480156104db57600080fd5b50610409610e0f565b6104f76104f236600461500c565b610e2b565b60405161030391906159d0565b6103b6610512366004614d60565b610e49565b34801561052357600080fd5b506102f6610532366004615108565b610e7d565b34801561054357600080fd5b50610409610ea2565b61055f61055a366004614cdc565b610ebe565b60405161030391906154b1565b34801561057857600080fd5b506103a1610587366004614e64565b610fe9565b61055f61059a366004614cdc565b611031565b6103b66105ad3660046150a8565b6110f8565b3480156105be57600080fd5b506105d26105cd366004614f82565b61111d565b6040516103039190615a12565b3480156105eb57600080fd5b506102f66105fa366004614fb5565b611201565b6103b661060d366004614d60565b611226565b34801561061e57600080fd5b506103a161062d366004614b65565b61125a565b6104f761064036600461500c565b611306565b61055f610653366004614cdc565b611324565b34801561066457600080fd5b506103a1610673366004614adb565b6113d9565b34801561068457600080fd5b5061032161147c565b34801561069957600080fd5b506103a16106a8366004614adb565b611482565b3480156106b957600080fd5b506103216106c8366004614af6565b611616565b3480156106d957600080fd5b506106e2611633565b604051610303919061562b565b6103a16106fd366004614c0d565b611657565b6103b66107103660046150a8565b611699565b34801561072157600080fd5b506104096116b4565b34801561073657600080fd5b506103a1610745366004614adb565b6116d0565b61075d610758366004614db3565b611748565b6040516103039190615433565b60056020526000908152604090205460ff1681565b60035481565b606061078f61187b565b156107a55761079e838361189d565b90506107c1565b6107ad6119b7565b6107b7838361189d565b90506107c16119f9565b92915050565b60096020526000908152604090205481565b600a6020526000908152604090205460ff1681565b6107f6611a2b565b6107ff81611a9a565b610807611ad7565b61080f611aeb565b50565b61081a614561565b61082261187b565b156108b857835160005b8181146108b157600061084c846020015187611b1590919063ffffffff16565b9050610856614561565b61088788848151811061086557fe5b60200260200101518388868151811061087a57fe5b6020026020010151611b34565b90506108938582611c75565b9450868560200151106108a75750506108b1565b505060010161082c565b5050610932565b6108c06119b7565b835160005b8181146109285760006108e5846020015187611b1590919063ffffffff16565b90506108ef614561565b6108fe88848151811061086557fe5b905061090a8582611c75565b94508685602001511061091e575050610928565b50506001016108c5565b50506109326119f9565b9392505050565b610941611a2b565b600061094b611d10565b600083815260076020908152604080832073ffffffffffffffffffffffffffffffffffffffff90941683529290522080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016600117905550610807611ad7565b6109b4611a2b565b60006109be611d10565b9050600073ffffffffffffffffffffffffffffffffffffffff821633146109e557336109e8565b60005b73ffffffffffffffffffffffffffffffffffffffff8084166000908152600b60209081526040808320938516835292905220549091506001840190808211610a3d57610a3d610a38858584611d42565b611de7565b73ffffffffffffffffffffffffffffffffffffffff8085166000818152600b602090815260408083209488168084529490915290819020859055517f82af639571738f4ebd4268fb0363d8957ebe1bbb9e78dba5ebd69eed39b154f090610aa59086906154cf565b60405180910390a350505050610807611ad7565b7fffffffff00000000000000000000000000000000000000000000000000000000811660009081526002602052604090205473ffffffffffffffffffffffffffffffffffffffff165b919050565b610b0f614590565b610b17611a2b565b610b25858585856001611def565b9050610b2f611ad7565b610b37611aeb565b949350505050565b610b47614590565b610b4f611a2b565b610b25858585856000611def565b610b65611a2b565b6000610b6f611d10565b73ffffffffffffffffffffffffffffffffffffffff8181166000818152600860209081526040808320948916808452949091529081902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00168715151790555192935090917fa8656e308026eeabce8f0bc18048433252318ab80ac79da0b3d3d8697dfba89190610c039086906154c4565b60405180910390a350610c14611ad7565b610c1c611aeb565b5050565b610c28614561565b610c3061187b565b15610cee57835160005b8181146108b1578251600090610c5790879063ffffffff611b1516565b90506000610c94888481518110610c6a57fe5b602002602001015160a00151898581518110610c8257fe5b6020026020010151608001518461215c565b9050610c9e614561565b610cc2898581518110610cad57fe5b60200260200101518389878151811061087a57fe5b9050610cce8682611c75565b955087866000015110610ce3575050506108b1565b505050600101610c3a565b610cf66119b7565b835160005b818114610928578251600090610d1890879063ffffffff611b1516565b90506000610d2b888481518110610c6a57fe5b9050610d35614561565b610d44898581518110610cad57fe5b9050610d508682611c75565b955087866000015110610d6557505050610928565b505050600101610cfb565b600860209081526000928352604080842090915290825290205460ff1681565b600080610d9e85858561217e565b90506005816008811115610dae57fe5b1480610dc557506007816008811115610dc357fe5b145b15610dda57610dda610a3860058787876121fd565b610de6818686866122a5565b95945050505050565b600760209081526000928352604080842090915290825290205460ff1681565b60045473ffffffffffffffffffffffffffffffffffffffff1681565b610e336145b8565b610e3b611a2b565b610b25858585856000612515565b610e51614561565b610e5c848484610c20565b9050828160000151101561093257610932610a386000858460000151612602565b600080610e956001548561262190919063ffffffff16565b9050610b37848285612635565b60005473ffffffffffffffffffffffffffffffffffffffff1681565b6060610ec861187b565b15610f6b578351604080518281526020808402820101909152818015610f0857816020015b610ef5614561565b815260200190600190039081610eed5790505b50915060005b8181146108b157610f4c868281518110610f2457fe5b6020026020010151868381518110610f3857fe5b602002602001015186848151811061087a57fe5b838281518110610f5857fe5b6020908102919091010152600101610f0e565b610f736119b7565b8351604080518281526020808402820101909152818015610fae57816020015b610f9b614561565b815260200190600190039081610f935790505b50915060005b81811461092857610fca868281518110610f2457fe5b838281518110610fd657fe5b6020908102919091010152600101610fb4565b610ff16126bb565b7f3a3e76d7a75e198aef1f53137e4f2a8a2ec74e2e9526db8404d08ccc9f1e621d60035482604051611024929190615543565b60405180910390a1600355565b606061103b611a2b565b835160408051828152602080840282010190915281801561107657816020015b611063614561565b81526020019060019003908161105b5790505b50915060005b8181146110e6576110c786828151811061109257fe5b60200260200101518683815181106110a657fe5b60200260200101518684815181106110ba57fe5b6020026020010151612702565b8382815181106110d357fe5b602090810291909101015260010161107c565b50506110f0611ad7565b610932611aeb565b611100614561565b611108611a2b565b611113848484612702565b90506110f0611ad7565b6111256145ec565b61112e826127a4565b60408301526020820152608082015161114e5760015b60ff168152610b02565b60a082015161115e576002611144565b8160a00151816040015110611174576005611144565b8161010001514210611187576004611144565b6020808201516000908152600a909152604090205460ff16156111ab576006611144565b610120820151825173ffffffffffffffffffffffffffffffffffffffff9081166000908152600b6020908152604080832060608801519094168352929052205411156111f8576006611144565b60038152919050565b600080611219600154856127d590919063ffffffff16565b9050610b378482856127e4565b61122e614561565b611239848484610812565b9050828160200151101561093257610932610a386001858460200151612602565b835160005b8181146112ca576112c28160001b87838151811061127957fe5b602002602001015187848151811061128d57fe5b60200260200101518785815181106112a157fe5b60200260200101518786815181106112b557fe5b6020026020010151612839565b60010161125f565b506040517f08c379a00000000000000000000000000000000000000000000000000000000081526004016112fd90615914565b60405180910390fd5b61130e6145b8565b611316611a2b565b610b25858585856001612515565b606061132e611a2b565b835160408051828152602080840282010190915281801561136957816020015b611356614561565b81526020019060019003908161134e5790505b50915060005b8181146110e6576113ba86828151811061138557fe5b602002602001015186838151811061139957fe5b60200260200101518684815181106113ad57fe5b60200260200101516129f3565b8382815181106113c657fe5b602090810291909101015260010161136f565b6113e16126bb565b6004546040517fe1a5430ebec577336427f40f15822f1f36c5e3509ff209d6db9e6c9e6941cb0b9161142d9173ffffffffffffffffffffffffffffffffffffffff90911690849061537c565b60405180910390a1600480547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff92909216919091179055565b60015481565b61148a6126bb565b60008173ffffffffffffffffffffffffffffffffffffffff1663ae25532e6040518163ffffffff1660e01b815260040160206040518083038186803b1580156114d257600080fd5b505afa1580156114e6573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525061150a9190810190614f09565b7fffffffff00000000000000000000000000000000000000000000000000000000811660009081526002602052604090205490915073ffffffffffffffffffffffffffffffffffffffff16801561156857611568610a388383612a26565b7fffffffff0000000000000000000000000000000000000000000000000000000082166000908152600260205260409081902080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff8616179055517fd2c6b762299c609bdb96520b58a49bfb80186934d4f71a86a367571a15c03194906116099084908690615658565b60405180910390a1505050565b600b60209081526000928352604080842090915290825290205481565b7f20c13b0b0000000000000000000000000000000000000000000000000000000081565b61165f611a2b565b805160005b81811461168f5761168783828151811061167a57fe5b6020026020010151611a9a565b600101611664565b5050610807611ad7565b6116a1614561565b6116a9611a2b565b6111138484846129f3565b60065473ffffffffffffffffffffffffffffffffffffffff1681565b6116d86126bb565b73ffffffffffffffffffffffffffffffffffffffff8116611703576116fe610a38612ac8565b61080f565b6000805473ffffffffffffffffffffffffffffffffffffffff83167fffffffffffffffffffffffff000000000000000000000000000000000000000090911617905550565b606061175261187b565b156117f457825160408051828152602080840282010190915260609082801561178f57816020015b606081526020019060019003908161177a5790505b50905060005b8281146117eb576117cc8682815181106117ab57fe5b60200260200101518683815181106117bf57fe5b602002602001015161189d565b8282815181106117d857fe5b6020908102919091010152600101611795565b509150506107c1565b6117fc6119b7565b825160408051828152602080840282010190915260609082801561183457816020015b606081526020019060019003908161181f5790505b50905060005b82811461186f576118508682815181106117ab57fe5b82828151811061185c57fe5b602090810291909101015260010161183a565b509150506107c16119f9565b6000547501000000000000000000000000000000000000000000900460ff1690565b606060006118b66001548561262190919063ffffffff16565b90506118c3848483612aff565b60608401516118d28180612bd3565b60008281526005602052604080822080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00166001179055608087015190516060913091611920919061530e565b600060405180830381855af49150503d806000811461195b576040519150601f19603f3d011682016040523d82523d6000602084013e611960565b606091505b50915091508161197757611977610a388583612c36565b611982836000612bd3565b60405184907fa4a7329f1dd821363067e07d359e347b4af9b1efe4b6cccf13240228af3c800d90600090a29695505050505050565b600080547fffffffffffffffffffff00ffffffffffffffffffffffffffffffffffffffffff167501000000000000000000000000000000000000000000179055565b600080547fffffffffffffffffffff00ffffffffffffffffffffffffffffffffffffffffff169055611a29612c53565b565b60005474010000000000000000000000000000000000000000900460ff1615611a5957611a59610a38612c88565b600080547fffffffffffffffffffffff00ffffffffffffffffffffffffffffffffffffffff1674010000000000000000000000000000000000000000179055565b611aa26145ec565b611aab8261111d565b9050611ab78282612cbf565b805160ff16600314611ac9575061080f565b610c1c828260200151612d6e565b611adf61187b565b611a2957611a29612c53565b600080547fffffffffffffffffffffff00ffffffffffffffffffffffffffffffffffffffff169055565b600082821115611b2e57611b2e610a3860028585612e17565b50900390565b611b3c614561565b6040516060907f9b44d5560000000000000000000000000000000000000000000000000000000090611b7690879087908790602401615a58565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050509050600060603073ffffffffffffffffffffffffffffffffffffffff1683604051611bfe919061530e565b600060405180830381855af49150503d8060008114611c39576040519150601f19603f3d011682016040523d82523d6000602084013e611c3e565b606091505b50915091508115611c6b57805160a014611c5457fe5b80806020019051611c689190810190614f25565b93505b5050509392505050565b611c7d614561565b81518351611c909163ffffffff612e3616565b815260208083015190840151611cab9163ffffffff612e3616565b602082015260408083015190840151611cc99163ffffffff612e3616565b604082015260608083015190840151611ce79163ffffffff612e3616565b606082015260808083015190840151611d059163ffffffff612e3616565b608082015292915050565b60065460009073ffffffffffffffffffffffffffffffffffffffff16818115611d395781611d3b565b335b9250505090565b6060634ad3127560e01b848484604051602401611d61939291906153a3565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff000000000000000000000000000000000000000000000000000000009093169290921790915290509392505050565b805160208201fd5b611df7614590565b8551611e0a57611e0a610a386000612e52565b8451611e1d57611e1d610a386001612e52565b8351865114611e3357611e33610a386002612e52565b8251855114611e4957611e49610a386003612e52565b8551604051908082528060200260200182016040528015611e8457816020015b611e71614561565b815260200190600190039081611e695790505b5081528451604080518281526020808402820101909152908015611ec257816020015b611eaf614561565b815260200190600190039081611ea75790505b506020820152600080611ed361460c565b88600081518110611ee057fe5b60200260200101519050611ef261460c565b88600081518110611eff57fe5b602002602001015190506000611f14836127a4565b9150506000611f22836127a4565b915050611f2d614561565b611f35614561565b611f3d6145b8565b611f7087878f8c81518110611f4e57fe5b60200260200101518f8c81518110611f6257fe5b60200260200101518f612515565b805160200151909150611f8a90869063ffffffff612e3616565b9450611fa781602001516020015185612e3690919063ffffffff16565b9350611fb7838260000151611c75565b9250611fc7828260200151611c75565b9150611fe481604001518b60400151612e3690919063ffffffff16565b60408b0152606080820151908b01516120029163ffffffff612e3616565b60608b015260a087015185106120ad578951805160018b019a859291811061202657fe5b60200260200101819052506040518060a0016040528060008152602001600081526020016000815260200160008152602001600081525092508e5189141561208a57818a60200151898151811061207957fe5b60200260200101819052505061214b565b8e898151811061209657fe5b602002602001015196506120a9876127a4565b9550505b8560a00151841061214557818a6020015189806001019a50815181106120cf57fe5b60200260200101819052506040518060a0016040528060008152602001600081526020016000815260200160008152602001600081525091508d5188141561212257828a600001518a8151811061207957fe5b8d888151811061212e57fe5b60200260200101519550612141866127a4565b9450505b50611f35565b505050505050505095945050505050565b6000610b3783612172868563ffffffff612ef116565b9063ffffffff612f2216565b600061218b848484612f4c565b905073ffffffffffffffffffffffffffffffffffffffff83166121b8576121b8610a3860068686866121fd565b600881818111156121c557fe5b60ff16106121dd576121dd610a3860038686866121fd565b60008160088111156121eb57fe5b141561093257610932610a3860048686865b6060637e5a231860e01b8585858560405160240161221e94939291906158b9565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909316929092179091529050949350505050565b600060018560088111156122b557fe5b14156122dc5781516001146122d4576122d4610a3860028686866121fd565b506000610b37565b60028560088111156122ea57fe5b14156123e357815160421461230957612309610a3860028686866121fd565b60008260008151811061231857fe5b016020015160f81c9050600061233584600163ffffffff612f8b16565b9050600061234a85602163ffffffff612f8b16565b9050600060018885858560405160008152602001604052604051612371949392919061560d565b6020604051602081039080840390855afa158015612393573d6000803e3d6000fd5b50506040517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0015173ffffffffffffffffffffffffffffffffffffffff8981169116149550610b37945050505050565b60038560088111156123f157fe5b141561249e57815160421461241057612410610a3860028686866121fd565b60008260008151811061241f57fe5b016020015160f81c9050600061243c84600163ffffffff612f8b16565b9050600061245185602163ffffffff612f8b16565b90506000600188604051602001612468919061532a565b6040516020818303038152906040528051906020012085858560405160008152602001604052604051612371949392919061560d565b60048560088111156124ac57fe5b14156124c4576124bd848484612fb5565b9050610b37565b60068560088111156124d257fe5b146124d957fe5b50600083815260076020908152604080832073ffffffffffffffffffffffffffffffffffffffff8616845290915290205460ff16949350505050565b61251d6145b8565b61016080870151610140808801919091528701519086015261253d6145ec565b6125468761111d565b90506125506145ec565b6125598761111d565b90506000612565611d10565b90506125738984838a6131ab565b61257f888383896131ab565b6125938989856020015185602001516132e1565b6125ac8989856040015185604001516003543a8b61332c565b93506125c78982856020015186604001518860000151613481565b6125e08882846020015185604001518860200151613481565b6125f6836020015183602001518b8b858961355f565b50505095945050505050565b60606318e4b14160e01b848484604051602401611d619392919061589e565b60006109328261263085613706565b61378e565b60608301516000908161264985838661217e565b9050600581600881111561265957fe5b141561267b5761267461266c87876137c8565b868487613800565b92506126b2565b600781600881111561268957fe5b14156126a35761267461269c87876137c8565b83866138b4565b6126af818684876122a5565b92505b50509392505050565b60005473ffffffffffffffffffffffffffffffffffffffff163314611a2957600054611a2990610a3890339073ffffffffffffffffffffffffffffffffffffffff166138c3565b61270a614561565b6127126145ec565b61271b8561111d565b90506000612727611d10565b9050612735868383876131ab565b600061275283604001518860a00151611b1590919063ffffffff16565b9050600061276087836138e0565b905061277088826003543a6138f6565b945060008460200151905061278c89858388604001518a613481565b612798818a868961396d565b50505050509392505050565b6000806127bc600154846127d590919063ffffffff16565b6000818152600960205260409020549092509050915091565b60006109328261263085613a04565b8251600090816127f585838661217e565b9050600581600881111561280557fe5b14156128185761267461266c8787613adb565b600781600881111561282657fe5b14156126a35761267461269c8787613adb565b80156129ec57600384511161285757612857610a3860008787613b13565b6000612869858263ffffffff613b3216565b7fffffffff00000000000000000000000000000000000000000000000000000000811660009081526002602052604090205490915073ffffffffffffffffffffffffffffffffffffffff16806128c8576128c8610a3860018989613b13565b6040516060907fa85e59e400000000000000000000000000000000000000000000000000000000906129049089908990899089906024016156b3565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050509050600060608373ffffffffffffffffffffffffffffffffffffffff168360405161298c919061530e565b6000604051808303816000865af19150503d80600081146129c9576040519150601f19603f3d011682016040523d82523d6000602084013e6129ce565b606091505b5091509150816129e6576129e6610a388b8b84613b7e565b50505050505b5050505050565b6129fb614561565b612a06848484612702565b90508281602001511461093257610932610a386002858460200151612602565b60606311c7b72060e01b8383604051602401612a43929190615658565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff0000000000000000000000000000000000000000000000000000000090931692909217909152905092915050565b60408051808201909152600481527fe69edc3e00000000000000000000000000000000000000000000000000000000602082015290565b82602001514210612b1857612b18610a38600183613b9d565b60408301513a8114612b3257612b32610a38833a84613bba565b60065473ffffffffffffffffffffffffffffffffffffffff168015612b5e57612b5e610a388483613bd9565b60008381526005602052604090205460ff1615612b8357612b83610a38600085613b9d565b606085015173ffffffffffffffffffffffffffffffffffffffff81163314801590612bb65750612bb4868587612635565b155b15612bcb57612bcb610a3860018684896121fd565b505050505050565b73ffffffffffffffffffffffffffffffffffffffff82163314610c1c576006805473ffffffffffffffffffffffffffffffffffffffff83167fffffffffffffffffffffffff00000000000000000000000000000000000000009091161790555050565b60606320d11f6160e01b8383604051602401612a43929190615551565b3031801561080f57604051339082156108fc029083906000818181858888f19350505050158015610c1c573d6000803e3d6000fd5b60408051808201909152600481527f0c3b823f00000000000000000000000000000000000000000000000000000000602082015290565b606082015173ffffffffffffffffffffffffffffffffffffffff1615612d1357606082015173ffffffffffffffffffffffffffffffffffffffff163314612d1357612d13610a386002836020015133613bf6565b6000612d1d611d10565b90508073ffffffffffffffffffffffffffffffffffffffff16836000015173ffffffffffffffffffffffffffffffffffffffff1614612d6957612d69610a386000846020015184613bf6565b505050565b6000818152600a60205260409081902080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001660011790558281015183516101408501516101608601519351859473ffffffffffffffffffffffffffffffffffffffff9485169493909316927f02c310a9a43963ff31a754a4099cc435ed498049687539d72d7818d9b093415c92612e0b92909190339061571b565b60405180910390a45050565b606063e946c1bb60e01b848484604051602401611d6193929190615846565b60008282018381101561093257610932610a3860008686612e17565b606063d4092f4f60e01b82604051602401612e6d9190615833565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909316929092179091529050919050565b600082612f00575060006107c1565b82820282848281612f0d57fe5b041461093257610932610a3860018686612e17565b600081612f3857612f38610a3860038585612e17565b6000828481612f4357fe5b04949350505050565b6000815160001415612f6857612f68610a3860028686866121fd565b81600183510381518110612f7857fe5b016020015160f81c6008811115610b3757fe5b60008160200183511015612fac57612fac610a386005855185602001613c15565b50016020015190565b8051600090612fec837fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff830163ffffffff613c3416565b6040516060907f1626ba7e00000000000000000000000000000000000000000000000000000000906130249088908790602401615551565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff000000000000000000000000000000000000000000000000000000009093169290921790915290506130b3848363ffffffff613c3416565b600060608673ffffffffffffffffffffffffffffffffffffffff16836040516130dc919061530e565b600060405180830381855afa9150503d8060008114613117576040519150601f19603f3d011682016040523d82523d6000602084013e61311c565b606091505b509150915081801561312f575080516020145b15613191577fb06713810000000000000000000000000000000000000000000000000000000061316682600063ffffffff613b3216565b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614945050505050610932565b6131a0610a3889898985613c38565b505050509392505050565b825160ff166003146131da576131da610a388460200151856000015160ff1660068111156131d557fe5b613c59565b606084015173ffffffffffffffffffffffffffffffffffffffff161561322e57606084015173ffffffffffffffffffffffffffffffffffffffff16331461322e5761322e610a386002856020015133613bf6565b602084015173ffffffffffffffffffffffffffffffffffffffff1615613298578173ffffffffffffffffffffffffffffffffffffffff16846020015173ffffffffffffffffffffffffffffffffffffffff161461329857613298610a386001856020015185613bf6565b8351604084015115806132b557506132b584602001518284613c76565b156129ec576132c9858560200151846127e4565b6129ec576129ec610a386000866020015184866121fd565b60a080840151908501516132fa9163ffffffff612ef116565b608080850151908601516133139163ffffffff612ef116565b101561332657613326610a388383613cc9565b50505050565b6133346145b8565b60a088015160009061334c908863ffffffff611b1516565b905060006133638a608001518b60a0015184613ce6565b9050600061337e888b60a00151611b1590919063ffffffff16565b905060006133958b608001518c60a0015184613ce6565b905085156133b2576133ab8c8c85878587613d1a565b94506133c3565b6133c08c8c85878587613dec565b94505b84515160808d015160c08e01516133db929190613ce6565b85516040015284516020015160a08d015160e08e01516133fc929190613ce6565b85516060015260208501515160808c015160c08d015161341d929190613ce6565b856020015160400181815250506134458560200151602001518c60a001518d60e00151613ce6565b6020860151606001526000613460888a63ffffffff612ef116565b86516080908101829052602088015101525050505050979650505050505050565b602081015161349790839063ffffffff612e3616565b600960008581526020019081526020016000208190555082856040015173ffffffffffffffffffffffffffffffffffffffff16866000015173ffffffffffffffffffffffffffffffffffffffff167f6869791f0a34781b29882982cc39e882768cf2c96995c2a110c577c53bc932d58861014001518961016001518a61018001518b6101a001518b338a600001518b602001518c604001518d606001518e608001516040516135509b9a99989796959493929190615767565b60405180910390a45050505050565b8351835160408087015190860151610140870151855160200151613588918b9186908890612839565b6135a28a8961014001518686896020015160200151612839565b6135bc898861018001518584896020015160400151612839565b6135d68a8961018001518685896000015160400151612839565b6135ec8a89610140015186898960400151612839565b6136028988610140015185898960600151612839565b600061361a8b8b88600001516080015188888c613e85565b905080613637578551600060809182018190526020880151909101525b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1614801561368757506101a080890151908a01516136879163ffffffff613ee216565b156136c5576136c08b8a6101a0015189866136bb8b60200151606001518c6000015160600151612e3690919063ffffffff16565b612839565b6136f9565b6136df8a896101a0015189858a6020015160600151612839565b6136f98b8a6101a0015189868a6000015160600151612839565b5050505050505050505050565b608081810151825160208085015160408087015160609788015186519685019690962082517fec69816980a3a3ca4554410e60253953e9ff375ba4536a98adfa15cc71541508815294850195909552908301919091529481019490945273ffffffffffffffffffffffffffffffffffffffff9091169183019190915260a082015260c0902090565b6040517f19010000000000000000000000000000000000000000000000000000000000008152600281019290925260228201526042902090565b6040516060907fde047db40000000000000000000000000000000000000000000000000000000090612a439085908590602401615a83565b8051600090601581101561381e5761381e610a3860028787876121fd565b6000613852847fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffeb840163ffffffff613f0716565b73ffffffffffffffffffffffffffffffffffffffff80871660009081526008602090815260408083209385168352929052205490915060ff1661389c5761389c610a388683613f47565b6138a98188866015613f64565b979650505050505050565b6000610b378385846001613f64565b6060631de45ad160e01b8383604051602401612a4392919061537c565b60008183106138ef5781610932565b5090919050565b6138fe614561565b6020810184905260a0850151608086015161391a918691613ce6565b815260a085015160c0860151613931918691613ce6565b604082015260a085015160e086015161394b918691613ce6565b6060820152613960828463ffffffff612ef116565b6080820152949350505050565b613987848461016001518486600001518560200151612839565b6139a1848461014001518560000151858560000151612839565b6139bb84846101a001518486604001518560600151612839565b6139d984846101800151856000015186604001518560400151612839565b60006139ef85836080015186600001518661413b565b9050806129ec57600060808301525050505050565b6101408101516101608201516101808301516101a08401516000937ff80322eb8376aafb64eadf8f0d7623f22130fd9491a221e902b713cb984a753493909290916020871015613a5057fe5b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe087018051610140890180516101608b0180516101808d0180516101a08f0180519d89528c5160209d8e012087528b519b8d019b909b2084528951998c01999099208152875197909a019690962088526101e085209390945290529190529252919091529050919050565b6040516060907f3efe50c80000000000000000000000000000000000000000000000000000000090612a439085908590602401615a36565b606063488219a660e01b848484604051602401611d619392919061580b565b60008160040183511015613b5357613b53610a386003855185600401613c15565b5001602001517fffffffff000000000000000000000000000000000000000000000000000000001690565b6060634678472b60e01b848484604051602401611d619392919061556a565b606063f598518460e01b8383604051602401612a439291906158fd565b606063a26dac0960e01b848484604051602401611d61939291906155f7565b606063dec4aedf60e01b8383604051602401612a439291906154d8565b606063e53c76c860e01b848484604051602401611d6193929190615867565b6060632800659560e01b848484604051602401611d61939291906158ab565b9052565b6060631b8388f760e01b8585858560405160240161221e94939291906154fc565b606063fdb6ca8d60e01b8383604051602401612a43929190615595565b600080613c84858585612f4c565b90506004816008811115613c9457fe5b1480613cab57506005816008811115613ca957fe5b145b80610de657506007816008811115613cbf57fe5b1495945050505050565b606063b6555d6f60e01b8383604051602401612a43929190615543565b6000613cf3848484614181565b15613d0657613d06610a388585856141e7565b610b3783612172868563ffffffff612ef116565b613d226145b8565b81851184841184861115613d4257613d3b898686614206565b9250613d91565b86841115613d825782518790528251602001869052608088015160a0890151613d6c919089613ce6565b6020808501805192909252905101879052613d91565b613d8e87878787614243565b92505b8115613db7576020808401510151835151613db19163ffffffff611b1516565b60408401525b8015613ddf5782516020908101519084015151613dd99163ffffffff611b1516565b60608401525b50505b9695505050505050565b613df46145b8565b82841115613e0e57613e07878484614206565b9050613e5c565b82841015613e4d5780518590528051602090810185905281015184905260a08601516080870151613e4091908661426e565b6020808301510152613e5c565b613e5985858585614243565b90505b6020808201510151815151613e769163ffffffff611b1516565b60408201529695505050505050565b60045460009073ffffffffffffffffffffffffffffffffffffffff168015613ed85730316000613eb98a84848b8b8a6142c2565b9050613ecb89848385038b8a8a6142c2565b5060019350505050613de2565b6000915050613de2565b6000815183511480156109325750508051602091820120825192909101919091201490565b60008160140183511015613f2857613f28610a386004855185601401613c15565b50016014015173ffffffffffffffffffffffffffffffffffffffff1690565b606063a15c0d0660e01b8383604051602401612a4392919061537c565b8151600090613f7b8484830363ffffffff613c3416565b6040516060907f20c13b0b0000000000000000000000000000000000000000000000000000000090613fb390889088906024016156f6565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909316929092179091529050614042858363ffffffff613c3416565b600060608873ffffffffffffffffffffffffffffffffffffffff168360405161406b919061530e565b600060405180830381855afa9150503d80600081146140a6576040519150601f19603f3d011682016040523d82523d6000602084013e6140ab565b606091505b50915091508180156140be575080516020145b15614120577f20c13b0b000000000000000000000000000000000000000000000000000000006140f582600063ffffffff613b3216565b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614945050505050610b37565b61412f610a388a8a8a856143fa565b50505050949350505050565b60045460009073ffffffffffffffffffffffffffffffffffffffff1680156141775761416c868230318888886142c2565b506001915050610b37565b6000915050610b37565b60008261419357614193610a3861441b565b81158061419e575083155b156141ab57506000610932565b600083806141b557fe5b85840990506141ca858463ffffffff612ef116565b6141dc826103e863ffffffff612ef116565b101595945050505050565b606063339f3de260e01b848484604051602401611d61939291906155f7565b61420e6145b8565b60208082018051859052518101839052815101839052608084015160a0850151614239919085613ce6565b8151529392505050565b61424b6145b8565b805194909452835160209081019390935282840180519290925290519091015290565b600061427b848484614452565b1561428e5761428e610a388585856141e7565b610b37836121726142a682600163ffffffff611b1516565b6142b6888763ffffffff612ef116565b9063ffffffff612e3616565b60008385106142ce5750825b6040516060907fa3b4a3270000000000000000000000000000000000000000000000000000000090614308908690869089906024016153a3565b604051602081830303815290604052907bffffffffffffffffffffffffffffffffffffffffffffffffffffffff19166020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff83818316178352505050509050600060608873ffffffffffffffffffffffffffffffffffffffff168484604051614391919061530e565b60006040518083038185875af1925050503d80600081146143ce576040519150601f19603f3d011682016040523d82523d6000602084013e6143d3565b606091505b5091509150816143ed576143ed610a388b898989866144b6565b5050509695505050505050565b6060635bd0428d60e01b8585858560405160240161221e94939291906153d4565b60408051808201909152600481527fa791837c00000000000000000000000000000000000000000000000000000000602082015290565b60008261446457614464610a3861441b565b81158061446f575083155b1561447c57506000610932565b6000838061448657fe5b85840990508361449c818363ffffffff611b1516565b816144a357fe5b0690506141ca858463ffffffff612ef116565b60606387cb1e7560e01b86868686866040516024016144d99594939291906155b2565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff0000000000000000000000000000000000000000000000000000000090931692909217909152905095945050505050565b6040518060a0016040528060008152602001600081526020016000815260200160008152602001600081525090565b6040518060800160405280606081526020016060815260200160008152602001600081525090565b60405180608001604052806145cb614561565b81526020016145d8614561565b815260200160008152602001600081525090565b604080516060810182526000808252602082018190529181019190915290565b604051806101c00160405280600073ffffffffffffffffffffffffffffffffffffffff168152602001600073ffffffffffffffffffffffffffffffffffffffff168152602001600073ffffffffffffffffffffffffffffffffffffffff168152602001600073ffffffffffffffffffffffffffffffffffffffff168152602001600081526020016000815260200160008152602001600081526020016000815260200160008152602001606081526020016060815260200160608152602001606081525090565b803573ffffffffffffffffffffffffffffffffffffffff811681146107c157600080fd5b600082601f830112614707578081fd5b813561471a61471582615b14565b615aed565b81815291506020808301908481018184028601820187101561473b57600080fd5b60005b848110156147625761475088836146d3565b8452928201929082019060010161473e565b505050505092915050565b600082601f83011261477d578081fd5b813561478b61471582615b14565b8181529150602080830190840160005b838110156147c8576147b3876020843589010161488b565b8352602092830192919091019060010161479b565b5050505092915050565b600082601f8301126147e2578081fd5b81356147f061471582615b14565b8181529150602080830190840160005b838110156147c8576148188760208435890101614912565b83526020928301929190910190600101614800565b600082601f83011261483d578081fd5b813561484b61471582615b14565b81815291506020808301908481018184028601820187101561486c57600080fd5b60005b848110156147625781358452928201929082019060010161486f565b600082601f83011261489b578081fd5b813567ffffffffffffffff8111156148b1578182fd5b6148e260207fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f84011601615aed565b91508082528360208285010111156148f957600080fd5b8060208401602084013760009082016020015292915050565b60006101c0808385031215614925578182fd5b61492e81615aed565b91505061493b83836146d3565b815261494a83602084016146d3565b602082015261495c83604084016146d3565b604082015261496e83606084016146d3565b60608201526080820135608082015260a082013560a082015260c082013560c082015260e082013560e08201526101008083013581830152506101208083013581830152506101408083013567ffffffffffffffff808211156149d057600080fd5b6149dc8683870161488b565b838501526101609250828501359150808211156149f857600080fd5b614a048683870161488b565b83850152610180925082850135915080821115614a2057600080fd5b614a2c8683870161488b565b838501526101a0925082850135915080821115614a4857600080fd5b50614a558582860161488b565b82840152505092915050565b600060a08284031215614a72578081fd5b614a7c60a0615aed565b90508135815260208201356020820152604082013560408201526060820135614aa481615b88565b6060820152608082013567ffffffffffffffff811115614ac357600080fd5b614acf8482850161488b565b60808301525092915050565b600060208284031215614aec578081fd5b61093283836146d3565b60008060408385031215614b08578081fd5b614b1284846146d3565b9150614b2184602085016146d3565b90509250929050565b60008060408385031215614b3c578182fd5b614b4684846146d3565b915060208301358015158114614b5a578182fd5b809150509250929050565b60008060008060808587031215614b7a578182fd5b843567ffffffffffffffff80821115614b91578384fd5b614b9d8883890161476d565b95506020870135915080821115614bb2578384fd5b614bbe888389016146f7565b94506040870135915080821115614bd3578384fd5b614bdf888389016146f7565b93506060870135915080821115614bf4578283fd5b50614c018782880161482d565b91505092959194509250565b600060208284031215614c1e578081fd5b813567ffffffffffffffff811115614c34578182fd5b610b37848285016147d2565b60008060008060808587031215614c55578182fd5b843567ffffffffffffffff80821115614c6c578384fd5b614c78888389016147d2565b95506020870135915080821115614c8d578384fd5b614c99888389016147d2565b94506040870135915080821115614cae578384fd5b614cba8883890161476d565b93506060870135915080821115614ccf578283fd5b50614c018782880161476d565b600080600060608486031215614cf0578081fd5b833567ffffffffffffffff80821115614d07578283fd5b614d13878388016147d2565b94506020860135915080821115614d28578283fd5b614d348783880161482d565b93506040860135915080821115614d49578283fd5b50614d568682870161476d565b9150509250925092565b600080600060608486031215614d74578081fd5b833567ffffffffffffffff80821115614d8b578283fd5b614d97878388016147d2565b9450602086013593506040860135915080821115614d49578283fd5b60008060408385031215614dc5578182fd5b823567ffffffffffffffff80821115614ddc578384fd5b81850186601f820112614ded578485fd5b80359250614dfd61471584615b14565b83815260208082019190838101885b87811015614e3557614e238c848435890101614a61565b85529382019390820190600101614e0c565b50919750880135945050505080821115614e4d578283fd5b50614e5a8582860161476d565b9150509250929050565b600060208284031215614e75578081fd5b5035919050565b60008060408385031215614e8e578182fd5b823591506020830135614b5a81615b88565b600080600060608486031215614eb4578081fd5b833592506020840135614ec681615b88565b9150604084013567ffffffffffffffff811115614ee1578182fd5b614d568682870161488b565b600060208284031215614efe578081fd5b813561093281615baa565b600060208284031215614f1a578081fd5b815161093281615baa565b600060a0828403128015614f37578182fd5b8015614f41578182fd5b50614f4c60a0615aed565b82518152602083015160208201526040830151604082015260608301516060820152608083015160808201528091505092915050565b600060208284031215614f93578081fd5b813567ffffffffffffffff811115614fa9578182fd5b610b3784828501614912565b60008060408385031215614fc7578182fd5b823567ffffffffffffffff80821115614fde578384fd5b614fea86838701614912565b93506020850135915080821115614fff578283fd5b50614e5a8582860161488b565b60008060008060808587031215615021578182fd5b843567ffffffffffffffff80821115615038578384fd5b61504488838901614912565b95506020870135915080821115615059578384fd5b61506588838901614912565b9450604087013591508082111561507a578384fd5b6150868883890161488b565b9350606087013591508082111561509b578283fd5b50614c018782880161488b565b6000806000606084860312156150bc578081fd5b833567ffffffffffffffff808211156150d3578283fd5b6150df87838801614912565b94506020860135935060408601359150808211156150fb578283fd5b50614d568682870161488b565b6000806040838503121561511a578182fd5b823567ffffffffffffffff80821115615131578384fd5b614fea86838701614a61565b73ffffffffffffffffffffffffffffffffffffffff169052565b6000815180845260208401935060208301825b828110156151935761517d8683516151e7565b60a095909501946020919091019060010161516a565b5093949350505050565b600081518084526151b5816020860160208601615b34565b601f017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0169290920160200192915050565b80518252602081015160208301526040810151604083015260608101516060830152608081015160808301525050565b60006101c061522784845161513d565b6020830151615239602086018261513d565b50604083015161524c604086018261513d565b50606083015161525f606086018261513d565b506080830151608085015260a083015160a085015260c083015160c085015260e083015160e08501526101008084015181860152506101208084015181860152506101408084015182828701526152b88387018261519d565b915050610160915081840151858203838701526152d5828261519d565b9250505061018080840151858303828701526152f1838261519d565b9150506101a091508184015185820383870152613de2828261519d565b60008251615320818460208701615b34565b9190910192915050565b7f19457468657265756d205369676e6564204d6573736167653a0a3332000000008152601c810191909152603c0190565b73ffffffffffffffffffffffffffffffffffffffff91909116815260200190565b73ffffffffffffffffffffffffffffffffffffffff92831681529116602082015260400190565b73ffffffffffffffffffffffffffffffffffffffff9384168152919092166020820152604081019190915260600190565b600073ffffffffffffffffffffffffffffffffffffffff8616825260806020830152615403608083018661519d565b8281036040840152615415818661519d565b8381036060850152615427818661519d565b98975050505050505050565b6000602080830181845280855180835260408601915060408482028701019250838701855b828110156154a4577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc088860301845261549285835161519d565b94509285019290850190600101615458565b5092979650505050505050565b6000602082526109326020830184615157565b901515815260200190565b90815260200190565b91825273ffffffffffffffffffffffffffffffffffffffff16602082015260400190565b600085825273ffffffffffffffffffffffffffffffffffffffff8516602083015260806040830152615531608083018561519d565b82810360608401526138a9818561519d565b918252602082015260400190565b600083825260406020830152610b37604083018461519d565b600084825260606020830152615583606083018561519d565b8281036040840152613de2818561519d565b828152604081016155a583615b7e565b8260208301529392505050565b600086825285602083015273ffffffffffffffffffffffffffffffffffffffff808616604084015280851660608401525060a060808301526138a960a083018461519d565b9283526020830191909152604082015260600190565b93845260ff9290921660208401526040830152606082015260800190565b7fffffffff0000000000000000000000000000000000000000000000000000000091909116815260200190565b7fffffffff0000000000000000000000000000000000000000000000000000000092909216825273ffffffffffffffffffffffffffffffffffffffff16602082015260400190565b600060208252610932602083018461519d565b6000608082526156c6608083018761519d565b73ffffffffffffffffffffffffffffffffffffffff95861660208401529390941660408201526060015292915050565b600060408252615709604083018561519d565b8281036020840152610de6818561519d565b60006060825261572e606083018661519d565b8281036020840152615740818661519d565b91505073ffffffffffffffffffffffffffffffffffffffff83166040830152949350505050565b600061016080835261577b8184018f61519d565b838103602085015261578d818f61519d565b91505082810360408401526157a2818d61519d565b83810360608501526157b4818d61519d565b73ffffffffffffffffffffffffffffffffffffffff9b8c16608086015299909a1660a0840152505060c081019590955260e08501939093526101008401919091526101208301526101409091015295945050505050565b600061581685615b60565b84825283602083015260606040830152610de6606083018461519d565b6020810161584083615b6a565b91905290565b6060810161585385615b6a565b938152602081019290925260409091015290565b6060810161587485615b74565b938152602081019290925273ffffffffffffffffffffffffffffffffffffffff1660409091015290565b6060810161585385615b74565b606081016008851061585357fe5b60006158c486615b7e565b85825284602083015273ffffffffffffffffffffffffffffffffffffffff8416604083015260806060830152613de2608083018461519d565b6040810161590a84615b60565b9281526020015290565b60208082526014908201527f5452414e53464552535f5355434345535346554c000000000000000000000000604082015260600190565b60006020825282516080602084015261596760a0840182615157565b602085015191507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08482030160408501526159a28183615157565b604086015160608601526060860151608086015280935050505092915050565b60a081016107c182846151e7565b6000610180820190506159e48284516151e7565b60208301516159f660a08401826151e7565b5060408301516101408301526060909201516101609091015290565b815160ff168152602080830151908201526040918201519181019190915260600190565b600060408252615a496040830185615217565b90508260208301529392505050565b600060608252615a6b6060830186615217565b8460208401528281036040840152613de2818561519d565b60006040825283516040830152602084015160608301526040840151608083015273ffffffffffffffffffffffffffffffffffffffff60608501511660a0830152608084015160a060c0840152615add60e084018261519d565b9150508260208301529392505050565b60405181810167ffffffffffffffff81118282101715615b0c57600080fd5b604052919050565b600067ffffffffffffffff821115615b2a578081fd5b5060209081020190565b60005b83811015615b4f578181015183820152602001615b37565b838111156133265750506000910152565b6002811061080f57fe5b6004811061080f57fe5b6003811061080f57fe5b6007811061080f57fe5b73ffffffffffffffffffffffffffffffffffffffff8116811461080f57600080fd5b7fffffffff000000000000000000000000000000000000000000000000000000008116811461080f57600080fd5b8351602094850120835193850193909320604080517f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f815295860194909452928401929092526060830152608082015260a090209056fea365627a7a723158206fc97c5a1d6fde6b2ada9eb4429966e52d7e2da39180893c04bf55c840b346a16c6578706572696d656e74616cf564736f6c634300050c0040" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:110](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L110)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:13398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13398)* + +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:13356](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13356)* + +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:13381](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13381)* + +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:13387](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L13387)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10467](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10467)* + +**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:10420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10420)* + +**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:10394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10394)* + +**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:112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L112)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L118)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:182](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L182)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L170)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:160](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L160)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### EIP712_EXCHANGE_DOMAIN_HASH + +#### ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:190](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L190)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:196](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L196)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:260](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L260)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:248](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L248)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:238](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L238)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### allowedValidators + +#### ▪ **allowedValidators**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:268](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L268)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:274](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.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 | - | +`index_1` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:353](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L353)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L341)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:326](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L326)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### batchCancelOrders + +#### ▪ **batchCancelOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:364](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L364)* + +Executes multiple calls of cancelOrder. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L420)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:531](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L531)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:462](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L462)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:682](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L682)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:630](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L630)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`Array`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:599](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L599)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:372](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L372)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:502](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L502)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchExecuteTransactions + +#### ▪ **batchExecuteTransactions**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:695](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L695)* + +Executes a batch of Exchange method calls in the context of signer(s). + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:748](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L748)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`transactions`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:846](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.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 | +------ | ------ | ------ | ------ | +`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:785](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L785)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:963](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L963)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string[]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:933](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L933)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactions`: `Array`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:909](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L909)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:705](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L705)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:818](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L818)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transactions` | `Array` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchFillOrKillOrders + +#### ▪ **batchFillOrKillOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:976](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L976)* + +Executes multiple calls of fillOrKillOrder. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1042](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1042)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1180](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1180)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1096](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1096)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1354](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1354)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`Array`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1306](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1306)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1271](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1271)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:987](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L987)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1140](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1140)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmounts` | `BigNumber`[] | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchFillOrders + +#### ▪ **batchFillOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1383](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1383)* + +Executes multiple calls of fillOrder. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1449)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1587](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1587)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1503](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1503)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1761](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1761)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`Array`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1713](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1713)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1678](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1678)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1394)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1547](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1547)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmounts` | `BigNumber`[] | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchFillOrdersNoThrow + +#### ▪ **batchFillOrdersNoThrow**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1790](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1790)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1856](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1856)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1994](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1994)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`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:1910](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1910)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2168)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`Array`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2120)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2085](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2085)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1801](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1801)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1954](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1954)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmounts` | `BigNumber`[] | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchMatchOrders + +#### ▪ **batchMatchOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2199](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2199)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2286](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2286)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2486](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2486)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:2360](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2360)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2714](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2714)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2666](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2666)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2614](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2614)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2212)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2421](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2421)* + +**Parameters:** + +Name | Type | +------ | ------ | +`leftOrders` | `Array` | +`rightOrders` | `Array` | +`leftSignatures` | string[] | +`rightSignatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### batchMatchOrdersWithMaximalFill + +#### ▪ **batchMatchOrdersWithMaximalFill**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2766](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2766)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2853](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2853)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3053](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3053)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:2927](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2927)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3281](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3281)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3233](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3233)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3181)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2779](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2779)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2988](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2988)* + +**Parameters:** + +Name | Type | +------ | ------ | +`leftOrders` | `Array` | +`rightOrders` | `Array` | +`leftSignatures` | string[] | +`rightSignatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### cancelOrder + +#### ▪ **cancelOrder**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3330)* + +After calling, the order can not be filled anymore. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3385](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3385)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3494](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3494)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:3426](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3426)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3641)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3589](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3589)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[object]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3561)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3338](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3338)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3465](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3465)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### cancelOrdersUpTo + +#### ▪ **cancelOrdersUpTo**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3655)* + +Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch +and senderAddress equal to msg.sender (or null address if msg.sender == makerAddress). + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3692](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3692)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`targetOrderEpoch`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3754](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3754)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:3720](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3720)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3828](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3828)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3816](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3816)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`targetOrderEpoch`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3803)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3664](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3664)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3739](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3739)* + +**Parameters:** + +Name | Type | +------ | ------ | +`targetOrderEpoch` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### cancelled + +#### ▪ **cancelled**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3836](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3836)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3842](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3842)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3912](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3912)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3900](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3900)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3889](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3889)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### currentContextAddress + +#### ▪ **currentContextAddress**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3920](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3920)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3926](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3926)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3990](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3990)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3978](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3978)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3968](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3968)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### executeTransaction + +#### ▪ **executeTransaction**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4001](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4001)* + +Executes an Exchange method call in the context of signer. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4051](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4051)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction structure. | +`signature` | string | Proof that transaction has been signed by signer. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`transaction`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4141)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:4086](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4086)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4253](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4253)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4225](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4225)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transaction`: object, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4202](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4202)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4010](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4010)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction 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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4118)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transaction` | object | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### fillOrKillOrder + +#### ▪ **fillOrKillOrder**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4266](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4266)* + +Fills the input order. Reverts if exact takerAssetFillAmount not filled. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4329)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4462](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4462)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:4381](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4381)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4627](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4627)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4581](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4581)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4547](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4547)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4276](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4276)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4424](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4424)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAssetFillAmount` | `BigNumber` | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### fillOrder + +#### ▪ **fillOrder**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4654](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4654)* + +Fills the input order. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4717](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4717)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4846](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4846)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:4764](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4764)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5011](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5011)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4965](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4965)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4931](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4931)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4664](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4664)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order struct containing order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signature` | string | Proof that order has been created by maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4807](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4807)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAssetFillAmount` | `BigNumber` | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### filled + +#### ▪ **filled**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5035](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5035)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5041](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5041)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5111)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5099](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5099)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5088](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5088)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getAssetProxy + +#### ▪ **getAssetProxy**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5122)* + +Gets an asset proxy. + +#### callAsync + +▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5130)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`assetProxyId` | string | - | Id of the asset proxy. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5201](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5201)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5189](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5189)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetProxyId`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5178](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5178)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxyId` | string | Id of the asset proxy. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getOrderInfo + +#### ▪ **getOrderInfo**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5212)* + +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:5220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5220)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`order` | object | - | Order to gather information on. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +OrderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5365](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5365)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5319](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5319)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5291](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5291)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order to gather information on. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### isValidHashSignature + +#### ▪ **isValidHashSignature**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5384](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5384)* + +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:5394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5394)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5480)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5468)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5452](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5452)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32-byte hash. | +`signerAddress` | string | Address that should have signed the given hash. | +`signature` | string | Proof that the hash has been signed by signer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### isValidOrderSignature + +#### ▪ **isValidOrderSignature**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5491](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5491)* + +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:5500](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5500)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5648](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5648)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5602](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5602)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5570](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5570)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The order. | +`signature` | string | Proof that the order has been signed by signer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### isValidTransactionSignature + +#### ▪ **isValidTransactionSignature**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5661](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5661)* + +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:5670](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5670)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5782](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5782)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5754](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5754)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transaction`: object, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5731](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5731)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 | The transaction. | +`signature` | string | Proof that the order has been signed by signer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### marketBuyOrdersFillOrKill + +#### ▪ **marketBuyOrdersFillOrKill**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5796](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5796)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5860](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5860)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Minimum amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5996](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5996)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:5913](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5913)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6165](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6165)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6117)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6082](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6082)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5806](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5806)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | 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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5957](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5957)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`makerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### marketBuyOrdersNoThrow + +#### ▪ **marketBuyOrdersNoThrow**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6194)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6258](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6258)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6394)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:6311](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6311)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6563](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6563)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6515](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6515)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6480)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6204](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6204)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6355)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`makerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### marketSellOrdersFillOrKill + +#### ▪ **marketSellOrdersFillOrKill**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6591](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6591)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6655)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Minimum amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6791](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6791)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:6708](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6708)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6960](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6960)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6912](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6912)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6877](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6877)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6601](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6601)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | 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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6752](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6752)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### marketSellOrdersNoThrow + +#### ▪ **marketSellOrdersNoThrow**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6989](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6989)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7053](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7053)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7189](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7189)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:7106](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7106)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7358)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7310](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7310)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7275](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7275)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6999](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6999)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7150](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7150)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### matchOrders + +#### ▪ **matchOrders**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7388](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7388)* + +Match two complementary orders that have a profitable spread. +Each order is filled at their respective price point. However, the calculations are +carried out as though the orders are both being filled at the right order's price point. +The profit made by the left order goes to the taker (who matched the two orders). + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7469](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7469)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7655)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:7539](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7539)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7875](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7875)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7829](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7829)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7779](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7779)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7399](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7399)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7598](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7598)* + +**Parameters:** + +Name | Type | +------ | ------ | +`leftOrder` | object | +`rightOrder` | object | +`leftSignature` | string | +`rightSignature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### matchOrdersWithMaximalFill + +#### ▪ **matchOrdersWithMaximalFill**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7927](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7927)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8008](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8008)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8200](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8200)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:8078](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8078)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8420)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8374](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8374)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8324](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8324)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7938](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7938)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8137)* + +**Parameters:** + +Name | Type | +------ | ------ | +`leftOrder` | object | +`rightOrder` | object | +`leftSignature` | string | +`rightSignature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### orderEpoch + +#### ▪ **orderEpoch**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8466](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8466)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8472](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8472)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`index_1` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8551](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8551)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8539](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8539)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8524](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8524)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### owner + +#### ▪ **owner**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8559](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8559)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8565](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8565)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8629](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8629)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8617)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8607](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8607)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### preSign + +#### ▪ **preSign**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8641)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8676)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32-byte hash. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`hash`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8733](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8733)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:8703](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8703)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8800](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8800)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8788](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8788)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8777](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8777)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`hash`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8649](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8649)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32-byte hash. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`hash`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8722](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8722)* + +**Parameters:** + +Name | Type | +------ | ------ | +`hash` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### preSigned + +#### ▪ **preSigned**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8808](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8808)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8814](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8814)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`index_1` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8893](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8893)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8881](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8881)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8866](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8866)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### protocolFeeCollector + +#### ▪ **protocolFeeCollector**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8901](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8901)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8907](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8907)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8971](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8971)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8959](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8959)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8949](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8949)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +___ + +### protocolFeeMultiplier + +#### ▪ **protocolFeeMultiplier**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8979](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8979)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8985](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8985)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9049](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9049)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9037](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9037)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9027](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9027)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +___ + +### registerAssetProxy + +#### ▪ **registerAssetProxy**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9061](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9061)* + +Registers an asset proxy to its asset proxy id. +Once an asset proxy is registered, it cannot be unregistered. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`assetProxy`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9096](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9096)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxy` | string | Address of new asset proxy to register. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`assetProxy`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9156](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9156)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9123](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9123)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxy` | string | Address of new asset proxy to register. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9229)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9217)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9204](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9204)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxy` | string | Address of new asset proxy to register. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9069](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9069)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxy` | string | Address of new asset proxy to register. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9142](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9142)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetProxy` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### setProtocolFeeCollectorAddress + +#### ▪ **setProtocolFeeCollectorAddress**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9240](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9240)* + +Allows the owner to update the protocolFeeCollector address. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9282](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9282)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`updatedProtocolFeeCollector`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9355)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9313](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9313)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9431)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9419](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9419)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`updatedProtocolFeeCollector`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9406](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9406)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9249](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9249)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9337](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9337)* + +**Parameters:** + +Name | Type | +------ | ------ | +`updatedProtocolFeeCollector` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### setProtocolFeeMultiplier + +#### ▪ **setProtocolFeeMultiplier**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9442)* + +Allows the owner to update the protocol fee multiplier. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9482](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9482)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9553](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9553)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9512](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9512)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9628)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9616](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9616)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`updatedProtocolFeeMultiplier`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9603](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9603)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9450](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9450)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9536](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9536)* + +**Parameters:** + +Name | Type | +------ | ------ | +`updatedProtocolFeeMultiplier` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### setSignatureValidatorApproval + +#### ▪ **setSignatureValidatorApproval**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9640](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9640)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9685](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9685)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`validatorAddress`: string, `approval`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9766](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9766)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9719](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9719)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9847](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9847)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9835](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9835)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, boolean]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`validatorAddress`: string, `approval`: boolean): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9820](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9820)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9649](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9649)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9746](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9746)* + +**Parameters:** + +Name | Type | +------ | ------ | +`validatorAddress` | string | +`approval` | boolean | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### simulateDispatchTransferFromCalls + +#### ▪ **simulateDispatchTransferFromCalls**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9858](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9858)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9919](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9919)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string[] | 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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10033](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10033)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:9965](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9965)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10135)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string[], string[], string[], `BigNumber`[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10121)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string[], string[], string[], `BigNumber`[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10099](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10099)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9873](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9873)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string[] | 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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9996](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9996)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetData` | string[] | +`fromAddresses` | string[] | +`toAddresses` | string[] | +`amounts` | `BigNumber`[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transactionsExecuted + +#### ▪ **transactionsExecuted**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10145](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10145)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10151](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10151)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10221](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10221)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10209)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10198](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10198)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transferOwnership + +#### ▪ **transferOwnership**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10229)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10262](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10262)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10317](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10317)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:10288](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10288)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10385](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10385)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10373](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10373)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10360](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10360)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10236](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10236)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10307](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10307)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ForwarderContract + + +## Constructors + + + +\+ **new ForwarderContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ForwarderContract](#class-forwardercontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1880](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1880)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ForwarderContract.deployedBytecode | + +**Returns:** *[ForwarderContract](#class-forwardercontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x6080604052600436106100655760003560e01c8063942d33c011610043578063942d33c014610102578063ae93b97a14610124578063f2fde38b1461013757610065565b8063442026ed14610097578063630f1e6c146100b75780638da5cb5b146100d7575b60025473ffffffffffffffffffffffffffffffffffffffff1633146100955761009561009033610157565b6101f6565b005b3480156100a357600080fd5b506100956100b2366004611bc6565b6101fe565b3480156100c357600080fd5b506100956100d2366004611c06565b6104a8565b3480156100e357600080fd5b506100ec6104f1565b6040516100f99190611dc0565b60405180910390f35b610115610110366004611b1d565b61050d565b6040516100f993929190612047565b610115610132366004611aa0565b610542565b34801561014357600080fd5b50610095610152366004611a68565b61059d565b60606308b1869860e01b826040516024016101729190611dc0565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909316929092179091529050919050565b805160208201fd5b600061024a600084848080601f016020809104026020016040519081016040528093929190818152602001838380828437600092019190915250929392505063ffffffff610614169050565b905060405161025890611d97565b60405180910390207bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614156104a35760015460405160009173ffffffffffffffffffffffffffffffffffffffff16906360704108906102d490611d97565b6040519081900381207fffffffff0000000000000000000000000000000000000000000000000000000060e084901b16825261031291600401611e5f565b60206040518083038186803b15801561032a57600080fd5b505afa15801561033e573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052506103629190810190611a84565b905073ffffffffffffffffffffffffffffffffffffffff811661038a5761038a61009061066a565b60006103d6601086868080601f016020809104026020016040519081016040528093929190818152602001838380828437600092019190915250929392505063ffffffff6106c4169050565b6040517f095ea7b300000000000000000000000000000000000000000000000000000000815290915073ffffffffffffffffffffffffffffffffffffffff82169063095ea7b39061044d9085907fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff90600401611de1565b602060405180830381600087803b15801561046757600080fd5b505af115801561047b573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525061049f9190810190611ba6565b5050505b505050565b6104b0610704565b6104a383838080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525085925061074d915050565b60005473ffffffffffffffffffffffffffffffffffffffff1681565b600080600061051a610838565b6105258888886108cd565b90935091506105358386866109f0565b9050955095509592505050565b600080600061054f610838565b6000610573670de0b6b3a764000061056d888263ffffffff610b8f16565b34610bb2565b9050610580888289610bdc565b90945092506105908487876109f0565b9150509450945094915050565b6105a5610704565b73ffffffffffffffffffffffffffffffffffffffff81166105d0576105cb610090610d9f565b610611565b600080547fffffffffffffffffffffffff00000000000000000000000000000000000000001673ffffffffffffffffffffffffffffffffffffffff83161790555b50565b60008160040183511015610635576106356100906003855185600401610dd6565b5060208183018101519101907fffffffff00000000000000000000000000000000000000000000000000000000165b92915050565b6040805160048152602481019091526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167ff3b96b8d0000000000000000000000000000000000000000000000000000000017905290565b600081601401835110156106e5576106e56100906004855185601401610dd6565b50016014015173ffffffffffffffffffffffffffffffffffffffff1690565b60005473ffffffffffffffffffffffffffffffffffffffff16331461074b5760005461074b9061009090339073ffffffffffffffffffffffffffffffffffffffff16610e7b565b565b600061075f838263ffffffff61061416565b905060405161076d90611d97565b60405180910390207bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614156107c9576107c48383610f1d565b6104a3565b6040516107d590611d45565b60405180910390207bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916141561082c576107c48383611085565b6104a361009082611152565b346108485761084861009061116d565b600260009054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1663d0e30db0346040518263ffffffff1660e01b81526004016000604051808303818588803b1580156108b257600080fd5b505af11580156108c6573d6000803e3d6000fd5b5050505050565b82516000908190815b8181146109d1578681815181106108e957fe5b6020026020010151608001516000148061091a575086818151811061090a57fe5b602002602001015160a001516000145b15610924576109c9565b6000610936878563ffffffff6111c716565b905060008061096c8a858151811061094a57fe5b602002602001015189868151811061095e57fe5b6020026020010151856111e6565b915091506109928a858151811061097f57fe5b602002602001015161014001518261074d565b6109a2878363ffffffff610b8f16565b96506109b4868263ffffffff610b8f16565b95508886106109c5575050506109d1565b5050505b6001016108d6565b50848210156109e7576109e76100908684611339565b50935093915050565b600066b1a2bc2ec50000831115610a0d57610a0d61009084611356565b34841115610a2257610a226100908534611371565b6000610a34348663ffffffff6111c716565b9050610a4984670de0b6b3a764000087610bb2565b915080821115610a6057610a60610090838361138e565b8015610b87576002546040517f2e1a7d4d00000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff90911690632e1a7d4d90610abc908490600401612030565b600060405180830381600087803b158015610ad657600080fd5b505af1158015610aea573d6000803e3d6000fd5b505050506000821115610b3c5760405173ffffffffffffffffffffffffffffffffffffffff84169083156108fc029084906000818181858888f19350505050158015610b3a573d6000803e3d6000fd5b505b6000610b4e828463ffffffff6111c716565b90508015610b8557604051339082156108fc029083906000818181858888f19350505050158015610b83573d6000803e3d6000fd5b505b505b509392505050565b600082820183811015610bab57610bab610090600086866113ab565b9392505050565b6000610bd483610bc8868563ffffffff6113ca16565b9063ffffffff6113fb16565b949350505050565b6000806000855190506000610c97600160009054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16631ce4c78b6040518163ffffffff1660e01b815260040160206040518083038186803b158015610c5257600080fd5b505afa158015610c66573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250610c8a9190810190611cad565b3a9063ffffffff6113ca16565b905060005b828114610d9457878181518110610caf57fe5b60200260200101516080015160001480610ce05750878181518110610cd057fe5b602002602001015160a001516000145b15610cea57610d8c565b6000610d0c83610d008a8963ffffffff6111c716565b9063ffffffff6111c716565b9050600080610d428b8581518110610d2057fe5b60200260200101518a8681518110610d3457fe5b602002602001015185611425565b91509150610d558b858151811061097f57fe5b610d65888363ffffffff610b8f16565b9750610d77878263ffffffff610b8f16565b9650898810610d8857505050610d94565b5050505b600101610c9c565b505050935093915050565b60408051808201909152600481527fe69edc3e00000000000000000000000000000000000000000000000000000000602082015290565b6060632800659560e01b848484604051602401610df593929190611ec1565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff000000000000000000000000000000000000000000000000000000009093169290921790915290509392505050565b6060631de45ad160e01b8383604051602401610e98929190611e07565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff0000000000000000000000000000000000000000000000000000000090931692909217909152905092915050565b6000610f3083601063ffffffff6106c416565b9050600060608273ffffffffffffffffffffffffffffffffffffffff16604051610f5990611d6e565b60405180910390203386604051602401610f74929190611de1565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529181526020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff00000000000000000000000000000000000000000000000000000000909416939093179092529051610ffd9190611d29565b6000604051808303816000865af19150503d806000811461103a576040519150601f19603f3d011682016040523d82523d6000602084013e61103f565b606091505b50915091508161105557611055610090826114ea565b3d15611074576000915060203d14156110745760206000803e60005191505b816108c6576108c6610090826114ea565b806001146110995761109961009082611505565b60006110ac83601063ffffffff6106c416565b905060006110c184602463ffffffff61152016565b6040517f23b872dd00000000000000000000000000000000000000000000000000000000815290915073ffffffffffffffffffffffffffffffffffffffff8316906323b872dd9061111a90309033908690600401611e2e565b600060405180830381600087803b15801561113457600080fd5b505af1158015611148573d6000803e3d6000fd5b5050505050505050565b6060637996a27160e01b826040516024016101729190611e5f565b6040805160048152602481019091526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f8c0e562b0000000000000000000000000000000000000000000000000000000017905290565b6000828211156111e0576111e0610090600285856113ab565b50900390565b6000808460e001516000148061121257506101608501516101a08601516112129163ffffffff61152c16565b1561128057600061122c8660a00151876080015186611552565b905061123661172e565b61124187838861157c565b9050611272816080015161126683606001518460200151610b8f90919063ffffffff16565b9063ffffffff610b8f16565b905190935091506113319050565b6101408501516101a086015161129b9163ffffffff61152c16565b156113205760006112cb8660a001516112c58860e0015189608001516111c790919063ffffffff16565b86611552565b90506112d561172e565b6112e087838861157c565b90506112fd81608001518260200151610b8f90919063ffffffff16565b60608201518251919550611317919063ffffffff6111c716565b92505050611331565b611331610090866101a001516116e9565b935093915050565b60606391353a0c60e01b8383604051602401610e98929190612039565b6060631174fb8060e01b826040516024016101729190612030565b606063cdcbed5d60e01b8383604051602401610e98929190612039565b606063ecf40fd960e01b8383604051602401610e98929190612039565b606063e946c1bb60e01b848484604051602401610df593929190611e9f565b6000826113d957506000610664565b828202828482816113e657fe5b0414610bab57610bab610090600186866113ab565b60008161141157611411610090600385856113ab565b600082848161141c57fe5b04949350505050565b6000808460e001516000148061145157506101408501516101a08601516114519163ffffffff61152c16565b156114a85761145e61172e565b61146986858761157c565b905061148681608001518260200151610b8f90919063ffffffff16565b606082015182519194506114a0919063ffffffff6111c716565b915050611331565b6101608501516101a08601516114c39163ffffffff61152c16565b156113205760a085015160e086015160009161122c916112c590829063ffffffff610b8f16565b6060635e7eb60f60e01b826040516024016101729190611e8c565b606063baffa47460e01b826040516024016101729190612030565b6000610bab8383611704565b600081518351148015610bab575081805190602001208380519060200120149392505050565b6000610bd483610bc861156c82600163ffffffff6111c716565b611266888763ffffffff6113ca16565b61158461172e565b6040516060907f9b44d55600000000000000000000000000000000000000000000000000000000906115be90879087908790602401611ecf565b604080517fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe08184030181529181526020820180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167fffffffff0000000000000000000000000000000000000000000000000000000090941693909317909252600154915190925073ffffffffffffffffffffffffffffffffffffffff90911690600090606090839061166f908690611d29565b6000604051808303816000865af19150503d80600081146116ac576040519150601f19603f3d011682016040523d82523d6000602084013e6116b1565b606091505b509150915081156116de57805160a0146116c757fe5b808060200190516116db9190810190611c50565b94505b505050509392505050565b60606331360af160e01b826040516024016101729190611e8c565b60008160200183511015611725576117256100906005855185602001610dd6565b50016020015190565b6040518060a0016040528060008152602001600081526020016000815260200160008152602001600081525090565b8035610664816120d4565b600082601f830112611778578081fd5b813561178b61178682612084565b61205d565b8181529150602080830190840160005b838110156117c8576117b387602084358901016119e1565b8352602092830192919091019060010161179b565b5050505092915050565b600082601f8301126117e2578081fd5b81356117f061178682612084565b818152915060208083019084810160005b8481101561198f57813587016101c0807fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0838c0301121561184157600080fd5b61184a8161205d565b6118568b87850161175d565b81526118658b6040850161175d565b868201526118768b6060850161175d565b60408201526118888b6080850161175d565b606082015260a0830135608082015260c083013560a082015260e083013560c08201526101008084013560e0830152610120808501358284015261014091508185013581840152506101608085013567ffffffffffffffff808211156118ed57600080fd5b6118fb8f8b848a01016119e1565b8486015261018093508387013591508082111561191757600080fd5b6119258f8b848a01016119e1565b838601526101a092508287013591508082111561194157600080fd5b61194f8f8b848a01016119e1565b848601528587013593508084111561196657600080fd5b50506119768d89848801016119e1565b9083015250865250509282019290820190600101611801565b505050505092915050565b60008083601f8401126119ab578182fd5b50813567ffffffffffffffff8111156119c2578182fd5b6020830191508360208285010111156119da57600080fd5b9250929050565b600082601f8301126119f1578081fd5b813567ffffffffffffffff811115611a07578182fd5b611a3860207fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f8401160161205d565b9150808252836020828501011115611a4f57600080fd5b8060208401602084013760009082016020015292915050565b600060208284031215611a79578081fd5b8135610bab816120d4565b600060208284031215611a95578081fd5b8151610bab816120d4565b60008060008060808587031215611ab5578283fd5b843567ffffffffffffffff80821115611acc578485fd5b611ad8888389016117d2565b95506020870135915080821115611aed578485fd5b50611afa87828801611768565b935050604085013591506060850135611b12816120d4565b939692955090935050565b600080600080600060a08688031215611b34578081fd5b853567ffffffffffffffff80821115611b4b578283fd5b611b5789838a016117d2565b9650602088013595506040880135915080821115611b73578283fd5b50611b8088828901611768565b935050606086013591506080860135611b98816120d4565b809150509295509295909350565b600060208284031215611bb7578081fd5b81518015158114610bab578182fd5b60008060208385031215611bd8578182fd5b823567ffffffffffffffff811115611bee578283fd5b611bfa8582860161199a565b90969095509350505050565b600080600060408486031215611c1a578283fd5b833567ffffffffffffffff811115611c30578384fd5b611c3c8682870161199a565b909790965060209590950135949350505050565b600060a0828403128015611c62578182fd5b8015611c6c578182fd5b50611c7760a061205d565b82518152602083015160208201526040830151604082015260608301516060820152608083015160808201528091505092915050565b600060208284031215611cbe578081fd5b5051919050565b73ffffffffffffffffffffffffffffffffffffffff169052565b60008151808452611cf78160208601602086016120a4565b601f017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0169290920160200192915050565b60008251611d3b8184602087016120a4565b9190910192915050565b7f455243373231546f6b656e28616464726573732c75696e7432353629000000008152601c0190565b7f7472616e7366657228616464726573732c75696e743235362900000000000000815260190190565b7f4552433230546f6b656e28616464726573732900000000000000000000000000815260130190565b73ffffffffffffffffffffffffffffffffffffffff91909116815260200190565b73ffffffffffffffffffffffffffffffffffffffff929092168252602082015260400190565b73ffffffffffffffffffffffffffffffffffffffff92831681529116602082015260400190565b73ffffffffffffffffffffffffffffffffffffffff9384168152919092166020820152604081019190915260600190565b7fffffffff0000000000000000000000000000000000000000000000000000000091909116815260200190565b600060208252610bab6020830184611cdf565b6060810160048510611ead57fe5b938152602081019290925260409091015290565b6060810160088510611ead57fe5b600060608252611ee3606083018651611cc5565b6020850151611ef56080840182611cc5565b506040850151611f0860a0840182611cc5565b506060850151611f1b60c0840182611cc5565b50608085015160e083015260a0850151610100818185015260c08701519150610120828186015260e0880151925061014083818701528289015193506101609250838387015281890151935061018091508382870152808901519350506101c06101a08181880152611f91610220880186611cdf565b848b015195507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffa09450848882030183890152611fcd8187611cdf565b925050828a0151945083878303016101e0880152611feb8286611cdf565b9250808a015194505050818582030161020086015261200a8184611cdf565b91505085602085015283810360408501526120258186611cdf565b979650505050505050565b90815260200190565b918252602082015260400190565b9283526020830191909152604082015260600190565b60405181810167ffffffffffffffff8111828210171561207c57600080fd5b604052919050565b600067ffffffffffffffff82111561209a578081fd5b5060209081020190565b60005b838110156120bf5781810151838201526020016120a7565b838111156120ce576000848401525b50505050565b73ffffffffffffffffffffffffffffffffffffffff8116811461061157600080fdfea365627a7a72315820afeb88c9cc19090963cb885eb76d709ca1a151f8f73996031898e2b50578a89b6c6578706572696d656e74616cf564736f6c634300050c0040" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L31)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1595](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1595)* + +**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:1547](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1547)* + +**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:1512](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1512)* + +**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:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L40)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L75)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded for the respective asset proxy. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L135)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L102)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:202](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L202)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:190](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L190)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:179](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L179)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`assetData`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L48)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded for the respective asset proxy. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`assetData`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L121)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetData` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### marketBuyOrdersWithEth + +#### ▪ **marketBuyOrdersWithEth**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:216](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L216)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:292](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L292)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | +`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 | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `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:457](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L457)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L355)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:638](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L638)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`BigNumber`, `BigNumber`, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, `BigNumber`, string[], `BigNumber`, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:578](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L578)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`Array`, `BigNumber`, string[], `BigNumber`, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:539](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L539)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:230](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L230)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | +`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 + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:403](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L403)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`makerAssetBuyAmount` | `BigNumber` | +`signatures` | string[] | +`feePercentage` | `BigNumber` | +`feeRecipient` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### marketSellOrdersWithEth + +#### ▪ **marketSellOrdersWithEth**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:654](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L654)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:726](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L726)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | +`feeRecipient` | string | Address that will receive ETH when orders are filled. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber, BigNumber]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:881](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L881)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`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:785](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L785)* + +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 + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1055](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1055)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`BigNumber`, `BigNumber`, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[], `BigNumber`, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:997](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L997)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`Array`, string[], `BigNumber`, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:960](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L960)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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 + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:667](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L667)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | +`feeRecipient` | string | Address that will receive ETH when orders are filled. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:831](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L831)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`signatures` | string[] | +`feePercentage` | `BigNumber` | +`feeRecipient` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### owner + +#### ▪ **owner**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1067](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1067)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1073](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1073)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1137)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1125](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1125)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1115](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1115)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transferOwnership + +#### ▪ **transferOwnership**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1145](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1145)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1178](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1178)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1233](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1233)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1204](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1204)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1301](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1301)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1289)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1276](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1276)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1152](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1152)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1223](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1223)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### withdrawAsset + +#### ▪ **withdrawAsset**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1314](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1314)* + +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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1356](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1356)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded for the respective asset proxy. | +`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`assetData`: string, `amount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1426](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.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. + +**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:1386](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1386)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded for the respective asset proxy. | +`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1504](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1504)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1492](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1492)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, `BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string, `amount`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1477](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1477)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded for the respective asset proxy. | +`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1323](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1323)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | Byte array encoded for the respective asset proxy. | +`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1410](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1410)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetData` | string | +`amount` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: IValidatorContract + + +## Constructors + + + +\+ **new IValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IValidatorContract](#class-ivalidatorcontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:238](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L238)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | IValidatorContract.deployedBytecode | + +**Returns:** *[IValidatorContract](#class-ivalidatorcontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string | undefined* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L31)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:207](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L207)* + +**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:165](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L165)* + +**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:140](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L140)* + +**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:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L35)* + +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:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L45)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`hash` | string | - | Message hash that is signed. | +`signerAddress` | string | - | Address that should have signed the given hash. | +`signature` | string | - | Proof of signing. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256("isValidValidatorSignature(address,bytes32,address,bytes)")) + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:132](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L132)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L120)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L103)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Message hash that is signed. | +`signerAddress` | string | Address that should have signed the given hash. | +`signature` | string | Proof of signing. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +
+ +# Class: IWalletContract + + +## Constructors + + + +\+ **new IWalletContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IWalletContract](#class-iwalletcontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:224](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L224)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | IWalletContract.deployedBytecode | + +**Returns:** *[IWalletContract](#class-iwalletcontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string | undefined* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L31)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L197)* + +**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:155](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L155)* + +**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:130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L130)* + +**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:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L35)* + +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:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L44)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`hash` | string | - | Message hash that is signed. | +`signature` | string | - | Proof of signing. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +magicValue `bytes4(0xb0671381)` if the signature check succeeds. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L122)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:110](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L110)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L95)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Message hash that is signed. | +`signature` | string | Proof of signing. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +
+ +# Class: OrderValidatorContract + + +## Constructors + + + +\+ **new OrderValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[OrderValidatorContract](#class-ordervalidatorcontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1787](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1787)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | OrderValidatorContract.deployedBytecode | + +**Returns:** *[OrderValidatorContract](#class-ordervalidatorcontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string | undefined* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L31)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1226](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1226)* + +**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:1178](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1178)* + +**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:1143](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1143)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_zrxAssetData` | string | + +**Returns:** *`Promise`* + +___ + +### `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + +Defined in base-contract/lib/src/index.d.ts:41 + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +## Object literals + +### getBalanceAndAllowance + +#### ▪ **getBalanceAndAllowance**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:250](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L250)* + +#### callAsync + +▸ **callAsync**(`target`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:256](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L256)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`target` | string | - | +`assetData` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise<[BigNumber, BigNumber]>`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L335)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`BigNumber`, `BigNumber`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:323](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L323)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `assetData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:308](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L308)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`assetData` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getBalancesAndAllowances + +#### ▪ **getBalancesAndAllowances**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:858](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L858)* + +#### callAsync + +▸ **callAsync**(`target`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:864](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L864)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`target` | string | - | +`assetData` | string[] | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`[], `BigNumber`[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:943](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L943)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`BigNumber`[], `BigNumber`[]]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:931](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L931)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[string, string[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `assetData`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:916](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L916)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`assetData` | string[] | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getERC721TokenOwner + +#### ▪ **getERC721TokenOwner**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:765](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L765)* + +#### callAsync + +▸ **callAsync**(`token`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:771](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L771)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`token` | string | - | +`tokenId` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:850](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L850)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:838](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L838)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`token`: string, `tokenId`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:823](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L823)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`token` | string | +`tokenId` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getOrderAndTraderInfo + +#### ▪ **getOrderAndTraderInfo**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L32)* + +#### callAsync + +▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, object]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.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. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`order` | object | - | +`takerAddress` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise<[object, object]>`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[object, object]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L212)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[object, object]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:162](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L162)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[object, string]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:132](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L132)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAddress` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getOrdersAndTradersInfo + +#### ▪ **getOrdersAndTradersInfo**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L343)* + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, Array]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L349)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`orders` | `Array` | - | +`takerAddresses` | string[] | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise<[Array, Array]>`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`Array`, `Array`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:525](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L525)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *[`Array`, `Array`]* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[]]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:475](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L475)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`Array`, string[]]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:444](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L444)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAddresses` | string[] | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getTraderInfo + +#### ▪ **getTraderInfo**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:951](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L951)* + +#### callAsync + +▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:957](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L957)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`order` | object | - | +`takerAddress` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1113](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1113)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *object* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1071](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1071)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *object* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1041](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1041)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAddress` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### getTradersInfo + +#### ▪ **getTradersInfo**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:563](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L563)* + +#### callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:569](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L569)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`orders` | `Array` | - | +`takerAddresses` | string[] | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise>`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:733](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L733)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`Array`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L689)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *`Array`* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[]): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:658](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L658)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAddresses` | string[] | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +
+ +# Class: WETH9Contract + + +## Constructors + + + +\+ **new WETH9Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[WETH9Contract](#class-weth9contract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1877](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1877)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | WETH9Contract.deployedBytecode | + +**Returns:** *[WETH9Contract](#class-weth9contract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x6080604052600436106100925760003560e01c63ffffffff16806306fdde031461009c578063095ea7b31461012657806318160ddd1461016b57806323b872dd146101925780632e1a7d4d146101c9578063313ce567146101e157806370a082311461020c57806395d89b411461023a578063a9059cbb1461024f578063d0e30db014610092578063dd62ed3e14610280575b61009a6102b4565b005b3480156100a857600080fd5b506100b1610303565b6040805160208082528351818301528351919283929083019185019080838360005b838110156100eb5781810151838201526020016100d3565b50505050905090810190601f1680156101185780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b34801561013257600080fd5b5061015773ffffffffffffffffffffffffffffffffffffffff600435166024356103af565b604080519115158252519081900360200190f35b34801561017757600080fd5b50610180610422565b60408051918252519081900360200190f35b34801561019e57600080fd5b5061015773ffffffffffffffffffffffffffffffffffffffff60043581169060243516604435610427565b3480156101d557600080fd5b5061009a6004356105c7565b3480156101ed57600080fd5b506101f661065c565b6040805160ff9092168252519081900360200190f35b34801561021857600080fd5b5061018073ffffffffffffffffffffffffffffffffffffffff60043516610665565b34801561024657600080fd5b506100b1610677565b34801561025b57600080fd5b5061015773ffffffffffffffffffffffffffffffffffffffff600435166024356106ef565b34801561028c57600080fd5b5061018073ffffffffffffffffffffffffffffffffffffffff60043581169060243516610703565b33600081815260036020908152604091829020805434908101909155825190815291517fe1fffcc4923d04b559f4d29a8bfc6cda04eb5b0d3c460751c2402c5c5cc9109c9281900390910190a2565b6000805460408051602060026001851615610100027fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190941693909304601f810184900484028201840190925281815292918301828280156103a75780601f1061037c576101008083540402835291602001916103a7565b820191906000526020600020905b81548152906001019060200180831161038a57829003601f168201915b505050505081565b33600081815260046020908152604080832073ffffffffffffffffffffffffffffffffffffffff8716808552908352818420869055815186815291519394909390927f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925928290030190a350600192915050565b303190565b73ffffffffffffffffffffffffffffffffffffffff831660009081526003602052604081205482111561045957600080fd5b73ffffffffffffffffffffffffffffffffffffffff841633148015906104cf575073ffffffffffffffffffffffffffffffffffffffff841660009081526004602090815260408083203384529091529020547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff14155b156105495773ffffffffffffffffffffffffffffffffffffffff8416600090815260046020908152604080832033845290915290205482111561051157600080fd5b73ffffffffffffffffffffffffffffffffffffffff841660009081526004602090815260408083203384529091529020805483900390555b73ffffffffffffffffffffffffffffffffffffffff808516600081815260036020908152604080832080548890039055938716808352918490208054870190558351868152935191937fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef929081900390910190a35060019392505050565b336000908152600360205260409020548111156105e357600080fd5b33600081815260036020526040808220805485900390555183156108fc0291849190818181858888f19350505050158015610622573d6000803e3d6000fd5b5060408051828152905133917f7fcf532c15f0a6db0bd6d0e038bea71d30d808c7d98cb3bf7268a95bf5081b65919081900360200190a250565b60025460ff1681565b60036020526000908152604090205481565b60018054604080516020600284861615610100027fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0190941693909304601f810184900484028201840190925281815292918301828280156103a75780601f1061037c576101008083540402835291602001916103a7565b60006106fc338484610427565b9392505050565b6004602090815260009283526040808420909152908252902054815600a165627a7a723058201ebe888a6b56dd871f599adbe0f19ec3c29c28aec0685788dfac9b37a99fc9d20029" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:67](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L67)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1861](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1861)* + +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:1819](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1819)* + +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:1844](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1844)* + +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:1850](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1850)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1522](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1522)* + +**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:1480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1480)* + +**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:1455](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1455)* + +**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:1361](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1361)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1367](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1367)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`index_1` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1446](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1446)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1434)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1419](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1419)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### approve + +#### ▪ **approve**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:147](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L147)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L181)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`guy` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`guy`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:243](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L243)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`guy` | string | - | +`wad` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L209)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`guy` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:319](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L319)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:307](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L307)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`guy`: string, `wad`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:292](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L292)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`guy` | string | +`wad` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:154](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L154)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`guy` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L229)* + +**Parameters:** + +Name | Type | +------ | ------ | +`guy` | string | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:861](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L861)* + +#### callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:867](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L867)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:939](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L939)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:927](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L927)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:914](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L914)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decimals + +#### ▪ **decimals**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:783](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L783)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:789](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L789)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:853](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L853)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *number* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:841](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L841)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:831](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L831)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### deposit + +#### ▪ **deposit**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1205](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1205)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1237](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1237)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1289)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1261](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1261)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1353](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1353)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1341)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1331)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1212)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1279](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1279)* + +**Parameters:** + +Name | Type | +------ | ------ | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### name + +#### ▪ **name**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:69](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L69)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L75)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:139](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L139)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:127](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L127)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.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). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### symbol + +#### ▪ **symbol**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:947](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L947)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:953](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L953)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1017](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1017)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1005](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1005)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:995](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L995)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### totalSupply + +#### ▪ **totalSupply**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:327](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L327)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:333](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L333)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:397](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L397)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:385](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L385)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:375](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L375)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transfer + +#### ▪ **transfer**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1025](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1025)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1059](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1059)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1121)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:1087](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1087)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1197)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1185](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1185)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`dst`: string, `wad`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.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 | +------ | ------ | +`dst` | string | +`wad` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1032](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1032)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1107](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1107)* + +**Parameters:** + +Name | Type | +------ | ------ | +`dst` | string | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:405](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L405)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L449)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`src` | string | - | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:529](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L529)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:484](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L484)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`src` | string | - | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:613](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L613)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:601](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L601)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`src`: string, `dst`: string, `wad`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:584](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L584)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`src` | string | +`dst` | string | +`wad` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:412](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L412)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`src` | string | - | +`dst` | string | - | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:514](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L514)* + +**Parameters:** + +Name | Type | +------ | ------ | +`src` | string | +`dst` | string | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### withdraw + +#### ▪ **withdraw**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:621](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L621)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:654](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L654)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`wad` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:709](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L709)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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:680](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L680)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:775](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L775)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *void* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:763](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L763)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *[`BigNumber`]* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`wad`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:752](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L752)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`wad` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L628)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`wad` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:699](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L699)* + +**Parameters:** + +Name | Type | +------ | ------ | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ZRXTokenContract + + +## Constructors + + + +\+ **new ZRXTokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ZRXTokenContract](#class-zrxtokencontract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1512](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1512)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ZRXTokenContract.deployedBytecode | + +**Returns:** *[ZRXTokenContract](#class-zrxtokencontract)* + +## Properties + +#### 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 + +___ + +### `Static` deployedBytecode + +▪ **deployedBytecode**: *string* = "0x606060405236156100965763ffffffff7c010000000000000000000000000000000000000000000000000000000060003504166306fdde038114610098578063095ea7b31461014657806318160ddd1461018657806323b872dd146101a8578063313ce567146101ee57806370a082311461021457806395d89b411461024f578063a9059cbb146102fd578063dd62ed3e1461033d575bfe5b34156100a057fe5b6100a861037e565b60408051602080825283518183015283519192839290830191850190808383821561010c575b80518252602083111561010c577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe090920191602091820191016100ce565b505050905090810190601f1680156101385780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b341561014e57fe5b61017273ffffffffffffffffffffffffffffffffffffffff600435166024356103b5565b604080519115158252519081900360200190f35b341561018e57fe5b61019661042d565b60408051918252519081900360200190f35b34156101b057fe5b61017273ffffffffffffffffffffffffffffffffffffffff60043581169060243516604435610433565b604080519115158252519081900360200190f35b34156101f657fe5b6101fe6105d4565b6040805160ff9092168252519081900360200190f35b341561021c57fe5b61019673ffffffffffffffffffffffffffffffffffffffff600435166105d9565b60408051918252519081900360200190f35b341561025757fe5b6100a8610605565b60408051602080825283518183015283519192839290830191850190808383821561010c575b80518252602083111561010c577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe090920191602091820191016100ce565b505050905090810190601f1680156101385780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b341561030557fe5b61017273ffffffffffffffffffffffffffffffffffffffff6004351660243561063c565b604080519115158252519081900360200190f35b341561034557fe5b61019673ffffffffffffffffffffffffffffffffffffffff60043581169060243516610727565b60408051918252519081900360200190f35b60408051808201909152601181527f30782050726f746f636f6c20546f6b656e000000000000000000000000000000602082015281565b73ffffffffffffffffffffffffffffffffffffffff338116600081815260016020908152604080832094871680845294825280832086905580518681529051929493927f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925929181900390910190a35060015b92915050565b60035481565b73ffffffffffffffffffffffffffffffffffffffff808416600081815260016020908152604080832033909516835293815283822054928252819052918220548390108015906104835750828110155b80156104b6575073ffffffffffffffffffffffffffffffffffffffff841660009081526020819052604090205483810110155b156105c65773ffffffffffffffffffffffffffffffffffffffff808516600090815260208190526040808220805487019055918716815220805484900390557fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8110156105585773ffffffffffffffffffffffffffffffffffffffff808616600090815260016020908152604080832033909416835292905220805484900390555b8373ffffffffffffffffffffffffffffffffffffffff168573ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef856040518082815260200191505060405180910390a3600191506105cb565b600091505b5b509392505050565b601281565b73ffffffffffffffffffffffffffffffffffffffff81166000908152602081905260409020545b919050565b60408051808201909152600381527f5a52580000000000000000000000000000000000000000000000000000000000602082015281565b73ffffffffffffffffffffffffffffffffffffffff3316600090815260208190526040812054829010801590610699575073ffffffffffffffffffffffffffffffffffffffff831660009081526020819052604090205482810110155b156107185773ffffffffffffffffffffffffffffffffffffffff33811660008181526020818152604080832080548890039055938716808352918490208054870190558351868152935191937fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef929081900390910190a3506001610427565b506000610427565b5b92915050565b73ffffffffffffffffffffffffffffffffffffffff8083166000908152600160209081526040808320938516835292905220545b929150505600a165627a7a72305820d984298155c708a8164f1cbf83c7275bcc6851dd082c0404013c1f4463b238fa0029" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L51)* + +## Methods + +### evmExecAsync + +▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* + + + +Defined in base-contract/lib/src/index.d.ts:42 + +**Parameters:** + +Name | Type | +------ | ------ | +`input` | `Buffer` | + +**Returns:** *`Promise`* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1496](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1496)* + +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:1454](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1454)* + +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:1479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1479)* + +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:1485](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1485)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1226](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1226)* + +**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:1184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1184)* + +**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:1159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1159)* + +**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/zrx_token.ts:1065](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1065)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1071](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1071)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`_owner` | string | - | +`_spender` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1150](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1150)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1138](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1138)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1123](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1123)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`_owner` | string | +`_spender` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### approve + +#### ▪ **approve**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L131)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:172](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L172)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:241](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L241)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`_spender` | string | - | +`_value` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:200](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L200)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:320](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L320)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:308](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L308)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:293](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L293)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:138](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L138)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:227](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L227)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### balanceOf + +#### ▪ **balanceOf**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:719](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L719)* + +#### callAsync + +▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:725](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L725)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`_owner` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:795](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L795)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:783](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L783)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:772](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L772)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`_owner` | string | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### decimals + +#### ▪ **decimals**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L641)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:647](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L647)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:711](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L711)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *number* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:699](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L699)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L689)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### name + +#### ▪ **name**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L53)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L59)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:123](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L123)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L111)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:101](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L101)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### symbol + +#### ▪ **symbol**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L803)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:809](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L809)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:873](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L873)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *string* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:861](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L861)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:851](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L851)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### totalSupply + +#### ▪ **totalSupply**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L328)* + +#### callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:334](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L334)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L398)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *`BigNumber`* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:386](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L386)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *void* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:376](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L376)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +The ABI encoded transaction data as a string + +___ + +### transfer + +#### ▪ **transfer**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:881](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L881)* + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:919](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L919)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:981](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L981)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`_to` | string | - | +`_value` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:947](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L947)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1057](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1057)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1045](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1045)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1030](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.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 | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:888](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L888)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | - | +`_value` | `BigNumber` | - | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:967](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L967)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +### transferFrom + +#### ▪ **transferFrom**: *object* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:409](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L409)* + +ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. + +#### awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:459](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L459)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:546](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L546)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_from` | string | - | Address to transfer from. | +`_to` | string | - | Address to transfer to. | +`_value` | `BigNumber` | - | Amount to transfer. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +Success of transfer. + +#### estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:497](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L497)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:633](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L633)* + +Decode the ABI-encoded return data from a transaction + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`returnData` | string | the data returned after transaction execution | + +**Returns:** *boolean* + +An array representing the output results in order. Keynames of nested structs are preserved. + +#### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:621](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L621)* + +Decode the ABI-encoded transaction data into its input arguments + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callData` | string | The ABI-encoded transaction data | + +**Returns:** *string* + +An array representing the input arguments in order. Keynames of nested structs are preserved. + +#### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:604](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L604)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:419](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L419)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:527](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L527)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ContractWrappers + +The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. + + +## Constructors + + + +\+ **new ContractWrappers**(`supportedProvider`: [SupportedProvider](#supportedprovider), `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L84)* + +Instantiates a new ContractWrappers instance. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | The Provider instance you would like the contract-wrappers library to use for interacting with the Ethereum network. | +`config` | [ContractWrappersConfig](#interface-contractwrappersconfig) | The configuration object. Look up the type for the description. | + +**Returns:** *[ContractWrappers](#class-contractwrappers)* + +An instance of the ContractWrappers class. + +## Properties + +#### contractAddresses + +• **contractAddresses**: *`ContractAddresses`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L43)* + +An index of the default contract addresses for this network. + +___ + +### coordinator + +• **coordinator**: *[CoordinatorWrapper](#class-coordinatorwrapper)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L82)* + +An instance of the CoordinatorWrapper class containing methods for interacting with the Coordinator extension contract. + +___ + +### devUtils + +• **devUtils**: *`DevUtilsContract`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L78)* + +An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract. + +___ + +### dutchAuction + +• **dutchAuction**: *`DutchAuctionContract`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L74)* + +An instance of the DutchAuctionContract class containing methods for interacting with any DutchAuction smart contract. + +___ + +### erc20Proxy + +• **erc20Proxy**: *`ERC20ProxyContract`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L52)* + +An instance of the ERC20ProxyContract class containing methods for interacting with the +erc20Proxy smart contract. + +___ + +### erc721Proxy + +• **erc721Proxy**: *`ERC721ProxyContract`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L57)* + +An instance of the ERC721ProxyContract class containing methods for interacting with the +erc721Proxy smart contract. + +___ + +### exchange + +• **exchange**: *`ExchangeContract`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L47)* + +An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. + +___ + +### forwarder + +• **forwarder**: *`ForwarderContract`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L66)* + +An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. + +___ + +### orderValidator + +• **orderValidator**: *`OrderValidatorContract`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L70)* + +An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract. + +___ + +### weth9 + +• **weth9**: *`WETH9Contract`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:62](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L62)* + +An instance of the WETH9Contract class containing methods for interacting with the +WETH9 smart contract. + +## Methods + +### getAbiDecoder + +▸ **getAbiDecoder**(): *`AbiDecoder`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:155](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L155)* + +Get the abi decoder instance currently used by contract-wrappers + +**Returns:** *`AbiDecoder`* + +AbiDecoder instance + +___ + +### getProvider + +▸ **getProvider**(): *[SupportedProvider](#supportedprovider)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L148)* + +Get the provider instance currently used by contract-wrappers + +**Returns:** *[SupportedProvider](#supportedprovider)* + +Web3 provider instance + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:138](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/contract_wrappers.ts#L138)* + +Unsubscribes from all subscriptions for all contracts. + +**Returns:** *void* + +
+ +# Class: CoordinatorWrapper + +This class includes all the functionality related to filling or cancelling orders through +the 0x V2 Coordinator extension contract. + + +## Constructors + + + +\+ **new CoordinatorWrapper**(`provider`: [SupportedProvider](#supportedprovider), `networkId`: number, `address?`: undefined | string, `exchangeAddress?`: undefined | string, `registryAddress?`: undefined | string): *[CoordinatorWrapper](#class-coordinatorwrapper)* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L43)* + +Instantiate CoordinatorWrapper + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`provider` | [SupportedProvider](#supportedprovider) | - | +`networkId` | number | Desired networkId. | +`address?` | undefined \| string | The address of the Coordinator contract. If undefined, will default to the known address corresponding to the networkId. | +`exchangeAddress?` | undefined \| string | The address of the Exchange contract. If undefined, will default to the known address corresponding to the networkId. | +`registryAddress?` | undefined \| string | The address of the CoordinatorRegistry contract. If undefined, will default to the known address corresponding to the networkId. | + +**Returns:** *[CoordinatorWrapper](#class-coordinatorwrapper)* + +## Properties + +### abi + +• **abi**: *[ContractAbi](#contractabi)* = Coordinator.compilerOutput.abi + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L34)* + +___ + +### address + +• **address**: *string* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L36)* + +___ + +### exchangeAddress + +• **exchangeAddress**: *string* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L37)* + +___ + +### networkId + +• **networkId**: *number* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L35)* + +___ + +### registryAddress + +• **registryAddress**: *string* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L38)* + +## Methods + +### assertValidCoordinatorApprovalsOrThrowAsync + +▸ **assertValidCoordinatorApprovalsOrThrowAsync**(`transaction`: `ZeroExTransaction`, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:529](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L529)* + +Validates that the 0x transaction has been approved by all of the feeRecipients that correspond to each order in the transaction's Exchange calldata. +Throws an error if the transaction approvals are not valid. Will not detect failures that would occur when the transaction is executed on the Exchange contract. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transaction` | `ZeroExTransaction` | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | Proof that the transaction has been signed by the signer. | +`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | + +**Returns:** *`Promise`* + +___ + +### batchFillOrKillOrdersAsync + +▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:241](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L241)* + +Batch version of fillOrKillOrderAsync. Executes multiple fills atomically in a single transaction. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | +`takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | +`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### batchFillOrdersAsync + +▸ **batchFillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:171](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L171)* + +Batch version of fillOrderAsync. Executes multiple fills atomically in a single transaction. +Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints +registered in the coordinator registry contract. It requests a signature from each coordinator server before +submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the +signatures and then fills the order through the Exchange contract. +If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | +`takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | +`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### batchFillOrdersNoThrowAsync + +▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:206](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L206)* + +No throw version of batchFillOrdersAsync + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | +`takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | +`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### batchHardCancelOrdersAsync + +▸ **batchHardCancelOrdersAsync**(`orders`: `SignedOrder`[], `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:460](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`orders` | `SignedOrder`[] | - | An array of orders to cancel. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### batchSoftCancelOrdersAsync + +▸ **batchSoftCancelOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:374](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L374)* + +Batch version of softCancelOrderAsync. Requests multiple soft cancels + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `SignedOrder`[] | An array of orders to cancel. | + +**Returns:** *`Promise`* + +CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response). + +___ + +### fillOrKillOrderAsync + +▸ **fillOrKillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:134](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L134)* + +Attempts to fill a specific amount of an order. If the entire amount specified cannot be filled, +the fill order is abandoned. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | +`takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | +`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### fillOrderAsync + +▸ **fillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:101](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L101)* + +Fills a signed order with an amount denominated in baseUnits of the taker asset. Under-the-hood, this +method uses the `feeRecipientAddress` of the order to look up the coordinator server endpoint registered in the +coordinator registry contract. It requests a signature from that coordinator server before +submitting the order and signature as a 0x transaction to the coordinator extension contract. The coordinator extension +contract validates signatures and then fills the order via the Exchange contract. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | +`takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | +`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### getSignerAddressAsync + +▸ **getSignerAddressAsync**(`hash`: string, `signature`: string): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L561)* + +Recovers the address of a signer given a hash and signature. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32 byte hash. | +`signature` | string | Proof that the hash has been signed by signer. | + +**Returns:** *`Promise`* + +Signer address. + +___ + +### hardCancelOrderAsync + +▸ **hardCancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:428](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L428)* + +Cancels an order on-chain by submitting an Ethereum transaction. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`order` | `Order` \| `SignedOrder` | - | An object that conforms to the Order or SignedOrder interface. The order you would like to cancel. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### hardCancelOrdersUpToAsync + +▸ **hardCancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:495](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L495)* + +Cancels orders on-chain by submitting an Ethereum transaction. +Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch +and senderAddress equal to coordinator extension contract address. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | - | Target order epoch. | +`senderAddress` | string | - | Address that should send the transaction. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### marketBuyOrdersNoThrowAsync + +▸ **marketBuyOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:276](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L276)* + +No throw version of marketBuyOrdersAsync + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | +`makerAssetFillAmount` | `BigNumber` | - | Maker asset fill amount. | +`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### marketSellOrdersNoThrowAsync + +▸ **marketSellOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:309](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/coordinator_wrapper.ts#L309)* + +No throw version of marketSellOrdersAsync + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | +`takerAssetFillAmount` | `BigNumber` | - | Taker asset fill amount. | +`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | +`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | + +**Returns:** *`Promise`* + +Transaction hash. + +___ + +### softCancelOrderAsync + +▸ **softCancelOrderAsync**(`order`: `Order` | `SignedOrder`): *`Promise`* + +*Defined in [contract-wrappers/src/coordinator_wrapper.ts:339](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | `Order` \| `SignedOrder` | An object that conforms to the Order or SignedOrder interface. The order you would like to cancel. | + +**Returns:** *`Promise`* + +CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response). + +
+ +# Class: 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/9fe6c196a/packages/utils/src/abi_decoder.ts#L42)* + +Instantiate an AbiDecoder + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`abiArrays` | [AbiDefinition](#abidefinition)[][] | An array of contract ABI's | + +**Returns:** *[AbiDecoder](#class-abidecoder)* + +AbiDecoder instance + +## Methods + +### addABI + +▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void* + +*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/utils/src/abi_decoder.ts#L158)* + +Adds a set of ABI definitions, after which calldata and logs targeting these ABI's can be decoded. +Additional properties can be included to disambiguate similar ABI's. For example, if two functions +have the same signature but different parameter names, then their ABI definitions can be disambiguated +by specifying a contract name. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`abiArray` | [AbiDefinition](#abidefinition)[] | - | +`contractName?` | undefined \| string | Name of contract that encapsulates the ABI definitions (optional). This can be used when decoding calldata to disambiguate methods with the same signature but different parameter names. | + +**Returns:** *void* + +___ + +### decodeCalldataOrThrow + +▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* + +*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/utils/src/abi_decoder.ts#L118)* + +Decodes calldata for a known ABI. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`calldata` | string | hex-encoded calldata. | +`contractName?` | undefined \| string | used to disambiguate similar ABI's (optional). | + +**Returns:** *`DecodedCalldata`* + +Decoded calldata. Includes: function name and signature, along with the decoded arguments. + +___ + +### tryToDecodeLogOrNoop + +▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* + +*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/utils/src/abi_decoder.ts#L58)* + +Attempt to decode a log given the ABI's the AbiDecoder knows about. + +**Type parameters:** + +▪ **ArgsType**: *`DecodedLogArgs`* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`log` | `LogEntry` | The log to attempt to decode | + +**Returns:** *`LogWithDecodedArgs` | [RawLog](#rawlog)* + +The decoded log if the requisite ABI was available. Otherwise the log unaltered. + +
+ +# Enumeration: CoordinatorRegistryEvents + + +## Enumeration members + +### CoordinatorEndpointSet + +• **CoordinatorEndpointSet**: = "CoordinatorEndpointSet" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L31)* + +
+ +# Enumeration: DummyERC20TokenEvents + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L31)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L32)* + +
+ +# Enumeration: DummyERC721TokenEvents + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L34)* + +___ + +### ApprovalForAll + +• **ApprovalForAll**: = "ApprovalForAll" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L35)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L36)* + +
+ +# Enumeration: ERC1155ProxyEvents + + +## Enumeration members + +### AuthorizedAddressAdded + +• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L33)* + +___ + +### AuthorizedAddressRemoved + +• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L34)* + +
+ +# Enumeration: ERC20ProxyEvents + + +## Enumeration members + +### AuthorizedAddressAdded + +• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L33)* + +___ + +### AuthorizedAddressRemoved + +• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L34)* + +
+ +# Enumeration: ERC20TokenEvents + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L32)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L31)* + +
+ +# Enumeration: ERC721ProxyEvents + + +## Enumeration members + +### AuthorizedAddressAdded + +• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L33)* + +___ + +### AuthorizedAddressRemoved + +• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L34)* + +
+ +# Enumeration: ERC721TokenEvents + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L34)* + +___ + +### ApprovalForAll + +• **ApprovalForAll**: = "ApprovalForAll" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L35)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L36)* + +
+ +# Enumeration: ExchangeEvents + + +## Enumeration members + +### AssetProxyRegistered + +• **AssetProxyRegistered**: = "AssetProxyRegistered" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L39)* + +___ + +### Cancel + +• **Cancel**: = "Cancel" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L40)* + +___ + +### CancelUpTo + +• **CancelUpTo**: = "CancelUpTo" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L41)* + +___ + +### Fill + +• **Fill**: = "Fill" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L42)* + +___ + +### ProtocolFeeCollectorAddress + +• **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L43)* + +___ + +### ProtocolFeeMultiplier + +• **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L44)* + +___ + +### SignatureValidatorApproval + +• **SignatureValidatorApproval**: = "SignatureValidatorApproval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L45)* + +___ + +### TransactionExecution + +• **TransactionExecution**: = "TransactionExecution" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L46)* + +
+ +# Enumeration: WETH9Events + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L35)* + +___ + +### Deposit + +• **Deposit**: = "Deposit" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L37)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L36)* + +___ + +### Withdrawal + +• **Withdrawal**: = "Withdrawal" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L38)* + +
+ +# Enumeration: ZRXTokenEvents + + +## Enumeration members + +### Approval + +• **Approval**: = "Approval" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L32)* + +___ + +### Transfer + +• **Transfer**: = "Transfer" + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L31)* + +
+ + + +# Enumeration: ContractError + + +## Enumeration members + +### ContractNotDeployedOnNetwork + +• **ContractNotDeployedOnNetwork**: = "CONTRACT_NOT_DEPLOYED_ON_NETWORK" + +*Defined in [contract-wrappers/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L16)* + +___ + +### ERC721NoApproval + +• **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" + +*Defined in [contract-wrappers/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L26)* + +___ + +### ERC721OwnerNotFound + +• **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND" + +*Defined in [contract-wrappers/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L25)* + +___ + +### InsufficientAllowanceForTransfer + +• **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER" + +*Defined in [contract-wrappers/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L17)* + +___ + +### InsufficientBalanceForTransfer + +• **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER" + +*Defined in [contract-wrappers/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L18)* + +___ + +### InsufficientEthBalanceForDeposit + +• **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT" + +*Defined in [contract-wrappers/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L19)* + +___ + +### InsufficientWEthBalanceForWithdrawal + +• **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL" + +*Defined in [contract-wrappers/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L20)* + +___ + +### InvalidJump + +• **InvalidJump**: = "INVALID_JUMP" + +*Defined in [contract-wrappers/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L21)* + +___ + +### OutOfGas + +• **OutOfGas**: = "OUT_OF_GAS" + +*Defined in [contract-wrappers/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L22)* + +___ + +### SignatureRequestDenied + +• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" + +*Defined in [contract-wrappers/src/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L27)* + +___ + +### SubscriptionAlreadyPresent + +• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" + +*Defined in [contract-wrappers/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L24)* + +___ + +### SubscriptionNotFound + +• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" + +*Defined in [contract-wrappers/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L23)* + +
+ +# Enumeration: ForwarderError + + +## Enumeration members + +### CompleteFillFailed + +• **CompleteFillFailed**: = "COMPLETE_FILL_FAILED" + +*Defined in [contract-wrappers/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L12)* + +
+ + + + + +# Enumeration: BlockParamLiteral + + +## Enumeration members + +### Earliest + +• **Earliest**: = "earliest" + +*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L478)* + +___ + +### Latest + +• **Latest**: = "latest" + +*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L479)* + +___ + +### Pending + +• **Pending**: = "pending" + +*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L480)* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Interface: CoordinatorRegistryCoordinatorEndpointSetEventArgs + + +## Index + +### Properties + +* [coordinatorEndpoint](#coordinatorendpoint) +* [coordinatorOperator](#coordinatoroperator) + +## Properties + +### coordinatorEndpoint + +• **coordinatorEndpoint**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L36)* + +___ + +### coordinatorOperator + +• **coordinatorOperator**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L35)* + +
+ +# Interface: DummyERC20TokenApprovalEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L36)* + +___ + +### _spender + +• **_spender**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L38)* + +
+ +# Interface: DummyERC20TokenTransferEventArgs + + +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L42)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L43)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L44)* + +
+ +# Interface: DummyERC721TokenApprovalEventArgs + + +## Index + +### Properties + +* [_approved](#_approved) +* [_owner](#_owner) +* [_tokenId](#_tokenid) + +## Properties + +### _approved + +• **_approved**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L41)* + +___ + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L40)* + +___ + +### _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L42)* + +
+ +# Interface: DummyERC721TokenApprovalForAllEventArgs + + +## Index + +### Properties + +* [_approved](#_approved) +* [_operator](#_operator) +* [_owner](#_owner) + +## Properties + +### _approved + +• **_approved**: *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L48)* + +___ + +### _operator + +• **_operator**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L47)* + +___ + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L46)* + +
+ +# Interface: DummyERC721TokenTransferEventArgs + + +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_tokenId](#_tokenid) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L52)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L53)* + +___ + +### _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L54)* + +
+ +# Interface: ERC1155ProxyAuthorizedAddressAddedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L39)* + +___ + +### target + +• **target**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L38)* + +
+ +# Interface: ERC1155ProxyAuthorizedAddressRemovedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L44)* + +___ + +### target + +• **target**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L43)* + +
+ +# Interface: ERC20ProxyAuthorizedAddressAddedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L39)* + +___ + +### target + +• **target**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L38)* + +
+ +# Interface: ERC20ProxyAuthorizedAddressRemovedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L44)* + +___ + +### target + +• **target**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L43)* + +
+ +# Interface: ERC20TokenApprovalEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L42)* + +___ + +### _spender + +• **_spender**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L43)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L44)* + +
+ +# Interface: ERC20TokenTransferEventArgs + + +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L36)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L38)* + +
+ +# Interface: ERC721ProxyAuthorizedAddressAddedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L39)* + +___ + +### target + +• **target**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L38)* + +
+ +# Interface: ERC721ProxyAuthorizedAddressRemovedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L44)* + +___ + +### target + +• **target**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L43)* + +
+ +# Interface: ERC721TokenApprovalEventArgs + + +## Index + +### Properties + +* [_approved](#_approved) +* [_owner](#_owner) +* [_tokenId](#_tokenid) + +## Properties + +### _approved + +• **_approved**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L41)* + +___ + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L40)* + +___ + +### _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L42)* + +
+ +# Interface: ERC721TokenApprovalForAllEventArgs + + +## Index + +### Properties + +* [_approved](#_approved) +* [_operator](#_operator) +* [_owner](#_owner) + +## Properties + +### _approved + +• **_approved**: *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L48)* + +___ + +### _operator + +• **_operator**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L47)* + +___ + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L46)* + +
+ +# Interface: ERC721TokenTransferEventArgs + + +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_tokenId](#_tokenid) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L52)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L53)* + +___ + +### _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L54)* + +
+ +# Interface: ExchangeAssetProxyRegisteredEventArgs + + +## Index + +### Properties + +* [assetProxy](#assetproxy) +* [id](#id) + +## Properties + +### assetProxy + +• **assetProxy**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* + +___ + +### id + +• **id**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* + +
+ +# Interface: ExchangeCancelEventArgs + + +## Index + +### Properties + +* [feeRecipientAddress](#feerecipientaddress) +* [makerAddress](#makeraddress) +* [makerAssetData](#makerassetdata) +* [orderHash](#orderhash) +* [senderAddress](#senderaddress) +* [takerAssetData](#takerassetdata) + +## Properties + +### feeRecipientAddress + +• **feeRecipientAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L56)* + +___ + +### makerAddress + +• **makerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L55)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L57)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:60](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L60)* + +___ + +### senderAddress + +• **senderAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L59)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:58](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L58)* + +
+ +# Interface: ExchangeCancelUpToEventArgs + + +## Index + +### Properties + +* [makerAddress](#makeraddress) +* [orderEpoch](#orderepoch) +* [orderSenderAddress](#ordersenderaddress) + +## Properties + +### makerAddress + +• **makerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* + +___ + +### orderEpoch + +• **orderEpoch**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* + +___ + +### orderSenderAddress + +• **orderSenderAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* + +
+ +# Interface: ExchangeFillEventArgs + + +## Index + +### Properties + +* [feeRecipientAddress](#feerecipientaddress) +* [makerAddress](#makeraddress) +* [makerAssetData](#makerassetdata) +* [makerAssetFilledAmount](#makerassetfilledamount) +* [makerFeeAssetData](#makerfeeassetdata) +* [makerFeePaid](#makerfeepaid) +* [orderHash](#orderhash) +* [protocolFeePaid](#protocolfeepaid) +* [senderAddress](#senderaddress) +* [takerAddress](#takeraddress) +* [takerAssetData](#takerassetdata) +* [takerAssetFilledAmount](#takerassetfilledamount) +* [takerFeeAssetData](#takerfeeassetdata) +* [takerFeePaid](#takerfeepaid) + +## Properties + +### feeRecipientAddress + +• **feeRecipientAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:71](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L71)* + +___ + +### makerAddress + +• **makerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L70)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L72)* + +___ + +### makerAssetFilledAmount + +• **makerAssetFilledAmount**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* + +___ + +### makerFeeAssetData + +• **makerFeeAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L74)* + +___ + +### makerFeePaid + +• **makerFeePaid**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:76](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L76)* + +___ + +### protocolFeePaid + +• **protocolFeePaid**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)* + +___ + +### senderAddress + +• **senderAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L78)* + +___ + +### takerAddress + +• **takerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:77](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L77)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L73)* + +___ + +### takerAssetFilledAmount + +• **takerAssetFilledAmount**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* + +___ + +### takerFeeAssetData + +• **takerFeeAssetData**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L75)* + +___ + +### takerFeePaid + +• **takerFeePaid**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)* + +
+ +# Interface: ExchangeProtocolFeeCollectorAddressEventArgs + + +## Index + +### Properties + +* [oldProtocolFeeCollector](#oldprotocolfeecollector) +* [updatedProtocolFeeCollector](#updatedprotocolfeecollector) + +## Properties + +### oldProtocolFeeCollector + +• **oldProtocolFeeCollector**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)* + +___ + +### updatedProtocolFeeCollector + +• **updatedProtocolFeeCollector**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)* + +
+ +# Interface: ExchangeProtocolFeeMultiplierEventArgs + + +## Index + +### Properties + +* [oldProtocolFeeMultiplier](#oldprotocolfeemultiplier) +* [updatedProtocolFeeMultiplier](#updatedprotocolfeemultiplier) + +## Properties + +### oldProtocolFeeMultiplier + +• **oldProtocolFeeMultiplier**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L92)* + +___ + +### updatedProtocolFeeMultiplier + +• **updatedProtocolFeeMultiplier**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L93)* + +
+ +# Interface: ExchangeSignatureValidatorApprovalEventArgs + + +## Index + +### Properties + +* [isApproved](#isapproved) +* [signerAddress](#signeraddress) +* [validatorAddress](#validatoraddress) + +## Properties + +### isApproved + +• **isApproved**: *boolean* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:99](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L99)* + +___ + +### signerAddress + +• **signerAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:97](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L97)* + +___ + +### validatorAddress + +• **validatorAddress**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:98](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L98)* + +
+ +# Interface: ExchangeTransactionExecutionEventArgs + + +## Index + +### Properties + +* [transactionHash](#transactionhash) + +## Properties + +### transactionHash + +• **transactionHash**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L103)* + +
+ +# Interface: WETH9ApprovalEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L42)* + +___ + +### _spender + +• **_spender**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L43)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* + +
+ +# Interface: WETH9DepositEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L54)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L55)* + +
+ +# Interface: WETH9TransferEventArgs + + +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L48)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L49)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L50)* + +
+ +# Interface: WETH9WithdrawalEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L59)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L60)* + +
+ +# Interface: ZRXTokenApprovalEventArgs + + +## Index + +### Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +## Properties + +### _owner + +• **_owner**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L42)* + +___ + +### _spender + +• **_spender**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L43)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L44)* + +
+ +# Interface: ZRXTokenTransferEventArgs + + +## Index + +### Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +## Properties + +### _from + +• **_from**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L36)* + +___ + +### _to + +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L37)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L38)* + +
+ +# Interface: ContractAddresses + + +## Properties + +### assetProxyOwner + +• **assetProxyOwner**: *string* + +*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L9)* + +___ + +### coordinator + +• **coordinator**: *string* + +*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L14)* + +___ + +### coordinatorRegistry + +• **coordinatorRegistry**: *string* + +*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L13)* + +___ + +### devUtils + +• **devUtils**: *string* + +*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L18)* + +___ + +### dutchAuction + +• **dutchAuction**: *string* + +*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L12)* + +___ + +### erc1155Proxy + +• **erc1155Proxy**: *string* + +*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L17)* + +___ + +### erc20Proxy + +• **erc20Proxy**: *string* + +*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L4)* + +___ + +### erc721Proxy + +• **erc721Proxy**: *string* + +*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L5)* + +___ + +### etherToken + +• **etherToken**: *string* + +*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L7)* + +___ + +### exchange + +• **exchange**: *string* + +*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L8)* + +___ + +### forwarder + +• **forwarder**: *string* + +*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L10)* + +___ + +### multiAssetProxy + +• **multiAssetProxy**: *string* + +*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L15)* + +___ + +### orderValidator + +• **orderValidator**: *string* + +*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L11)* + +___ + +### staticCallProxy + +• **staticCallProxy**: *string* + +*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L16)* + +___ + +### zrxToken + +• **zrxToken**: *string* + +*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L6)* + +
+ +# Interface: ContractWrappersConfig + +networkId: The id of the underlying ethereum network your provider is connected to. (1-mainnet, 3-ropsten, 4-rinkeby, 42-kovan, 50-testrpc) +gasPrice: Gas price to use with every transaction +contractAddresses: The address of all contracts to use. Defaults to the known addresses based on networkId. +blockPollingIntervalMs: The interval to use for block polling in event watching methods (defaults to 1000) + + +## Properties + +### `Optional` blockPollingIntervalMs + +• **blockPollingIntervalMs**? : *undefined | number* + +*Defined in [contract-wrappers/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L40)* + +___ + +### `Optional` contractAddresses + +• **contractAddresses**? : *[ContractAddresses](#class-contractaddresses)* + +*Defined in [contract-wrappers/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L39)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *`BigNumber`* + +*Defined in [contract-wrappers/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L38)* + +___ + +### networkId + +• **networkId**: *number* + +*Defined in [contract-wrappers/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L37)* + +
+ + + + + + + +# 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:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L50)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *`BigNumber`* + +*Inherited from [TransactionOpts](#interface-transactionopts).[gasPrice](#optional-gasprice)* + +*Defined in [contract-wrappers/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L49)* + +___ + +### `Optional` nonce + +• **nonce**? : *undefined | number* + +*Inherited from [TransactionOpts](#interface-transactionopts).[nonce](#optional-nonce)* + +*Defined in [contract-wrappers/src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L51)* + +___ + +### `Optional` shouldValidate + +• **shouldValidate**? : *undefined | false | true* + +*Defined in [contract-wrappers/src/types.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L59)* + +
+ + + + + + + + + +# Interface: BlockRange + + +## Properties + +### fromBlock + +• **fromBlock**: *[BlockParam](#blockparam)* + +*Defined in [ethereum-types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L740)* + +___ + +### toBlock + +• **toBlock**: *[BlockParam](#blockparam)* + +*Defined in [ethereum-types/src/index.ts:741](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L741)* + +
+ + + + + +# Interface: CallData + + +## Properties + +### `Optional` data + +• **data**? : *undefined | string* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* + +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* + +___ + +### `Optional` from + +• **from**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L402)* + +___ + +### `Optional` gas + +• **gas**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* + +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* + +___ + +### `Optional` gasPrice + +• **gasPrice**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* + +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* + +___ + +### `Optional` nonce + +• **nonce**? : *undefined | number* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* + +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* + +___ + +### `Optional` to + +• **to**? : *undefined | string* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* + +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* + +___ + +### `Optional` value + +• **value**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* + +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)* + +
+ + + + + +# Interface: CompilerOpts + + +## Properties + +### name + +• **name**: *"solc"* + +*Defined in [ethereum-types/src/index.ts:655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L655)* + +___ + +### settings + +• **settings**: *[CompilerSettings](#class-compilersettings)* + +*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L657)* + +___ + +### version + +• **version**: *string* + +*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L656)* + +
+ +# 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/9fe6c196a/packages/ethereum-types/src/index.ts#L689)* + +___ + +### `Optional` libraries + +• **libraries**? : *undefined | object* + +*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L691)* + +___ + +### `Optional` metadata + +• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* + +*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L690)* + +___ + +### `Optional` optimizer + +• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* + +*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L688)* + +___ + +### outputSelection + +• **outputSelection**: *object* + +*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L696)* + +#### 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/9fe6c196a/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/9fe6c196a/packages/ethereum-types/src/index.ts#L704)* + +
+ +# Interface: ConstructorAbi + + +## Properties + +### inputs + +• **inputs**: *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L103)* + +___ + +### payable + +• **payable**: *boolean* + +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L104)* + +___ + +### stateMutability + +• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* + +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L105)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L102)* + +
+ +# Interface: ContractArtifact + +This type defines the schema of the artifact.json file generated by Sol-compiler +schemaVersion: The version of the artifact schema +contractName: The contract name it represents +networks: Network specific information by network (address, id, constructor args, etc...) +compilerOutput: The Solidity compiler output generated from the specified compiler input +description (http://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description) +compiler: The compiler settings used +sourceCodes: The source code of the contract and all it's dependencies +sources: A mapping from source filePath to sourceMap id +sourceTreeHashHex: A unique hash generated from the contract source and that of it's dependencies. +If any of the sources change, the hash would change notifying us that a re-compilation is necessary + + +## Properties + +### compiler + +• **compiler**: *[CompilerOpts](#class-compileropts)* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* + +*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L641)* + +___ + +### compilerOutput + +• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* + +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L651)* + +___ + +### contractName + +• **contractName**: *string* + +*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L675)* + +___ + +### networks + +• **networks**: *[ContractNetworks](#class-contractnetworks)* + +*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L676)* + +___ + +### schemaVersion + +• **schemaVersion**: *string* + +*Defined in [ethereum-types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L674)* + +___ + +### sourceCodes + +• **sourceCodes**: *object* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* + +*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L647)* + +#### Type declaration: + +● \[▪ **sourceName**: *string*\]: string + +___ + +### sourceTreeHashHex + +• **sourceTreeHashHex**: *string* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* + +*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L650)* + +___ + +### sources + +• **sources**: *object* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* + +*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L642)* + +#### Type declaration: + +● \[▪ **sourceName**: *string*\]: object + +
+ +# Interface: ContractNetworkData + + +## Properties + +### address + +• **address**: *string* + +*Defined in [ethereum-types/src/index.ts:554](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L554)* + +___ + +Args + +• **constructorArgs**: *string* + +*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L558)* + +___ + +### links + +• **links**: *object* + +*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L555)* + +#### Type declaration: + +● \[▪ **linkName**: *string*\]: string + +
+ +# Interface: ContractNetworks + + +## Hierarchy + +* **ContractVersionData** + + * [ContractArtifact](#class-contractartifact) + + +## Properties + +### compiler + +• **compiler**: *[CompilerOpts](#class-compileropts)* + +*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L641)* + +___ + +### compilerOutput + +• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* + +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L651)* + +___ + +### sourceCodes + +• **sourceCodes**: *object* + +*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L647)* + +#### Type declaration: + +● \[▪ **sourceName**: *string*\]: string + +___ + +### sourceTreeHashHex + +• **sourceTreeHashHex**: *string* + +*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L650)* + +___ + +### sources + +• **sources**: *object* + +*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L642)* + +#### Type declaration: + +● \[▪ **sourceName**: *string*\]: object + +
+ +# Interface: DataItem + + +## Properties + +### `Optional` components + +• **components**? : *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* + +___ + +### name + +• **name**: *string* + +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)* + +
+ +# Interface: DecodedLogArgs + + +## Type parameters + +▪ **A** + + +## Properties + +### address + +• **address**: *string* + +*Inherited from [LogEntry](#interface-logentry).[address](#address)* + +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* + +___ + +### args + +• **args**: *`A`* + +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* + +___ + +### blockHash + +• **blockHash**: *string | null* + +*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* + +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* + +___ + +### blockNumber + +• **blockNumber**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* + +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* + +___ + +### data + +• **data**: *string* + +*Inherited from [LogEntry](#interface-logentry).[data](#data)* + +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* + +___ + +### event + +• **event**: *string* + +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* + +___ + +### logIndex + +• **logIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* + +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* + +___ + +### topics + +• **topics**: *string[]* + +*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* + +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* + +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* + +___ + +### transactionIndex + +• **transactionIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* + +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)* + +
+ +# Interface: DecodedLogEntryEvent <**A**> + +## Type parameters + +▪ **A** + + +## Properties + +### address + +• **address**: *string* + +*Inherited from [LogEntry](#interface-logentry).[address](#address)* + +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* + +___ + +### args + +• **args**: *`A`* + +*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* + +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* + +___ + +### blockHash + +• **blockHash**: *string | null* + +*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* + +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* + +___ + +### blockNumber + +• **blockNumber**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* + +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* + +___ + +### data + +• **data**: *string* + +*Inherited from [LogEntry](#interface-logentry).[data](#data)* + +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* + +___ + +### event + +• **event**: *string* + +*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* + +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* + +___ + +### logIndex + +• **logIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* + +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* + +___ + +### removed + +• **removed**: *boolean* + +*Defined in [ethereum-types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L421)* + +___ + +### topics + +• **topics**: *string[]* + +*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* + +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* + +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* + +___ + +### transactionIndex + +• **transactionIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* + +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)* + +
+ +# Interface: DevdocOutput + + +## Properties + +### `Optional` author + +• **author**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L628)* + +___ + +### methods + +• **methods**: *object* + +*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L629)* + +#### Type declaration: + +● \[▪ **signature**: *string*\]: object + +___ + +### `Optional` title + +• **title**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L627)* + +
+ +# Interface: EIP1193Provider + + +## Properties + +### isEIP1193 + +• **isEIP1193**: *boolean* + +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* + +## Methods + +### on + +▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* + +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* + +**Parameters:** + +▪ **event**: *[EIP1193Event](#eip1193event)* + +▪ **listener**: *function* + +▸ (`result`: any): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`result` | any | + +**Returns:** *this* + +___ + +### send + +▸ **send**(`method`: string, `params?`: any[]): *`Promise`* + +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* + +**Parameters:** + +Name | Type | +------ | ------ | +`method` | string | +`params?` | any[] | + +**Returns:** *`Promise`* + +
+ + + + + +# Interface: EvmBytecodeOutput + + +## Properties + +### object + +• **object**: *string* + +*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L622)* + +___ + +### sourceMap + +• **sourceMap**: *string* + +*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L623)* + +
+ +# Interface: EvmOutput + + +## Properties + +### bytecode + +• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* + +*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L617)* + +___ + +### deployedBytecode + +• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* + +*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L618)* + +
+ +# Interface: FallbackAbi + + +## Properties + +### payable + +• **payable**: *boolean* + +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L112)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L111)* + +
+ + + +# Interface: GanacheProvider + + +## Methods + +### sendAsync + +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* + +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L14)* + +**Parameters:** + +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | + +**Returns:** *void* + +
+ + + +# Interface: JSONRPCRequestPayload + + +## Properties + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* + +___ + +### method + +• **method**: *string* + +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* + +___ + +### params + +• **params**: *any[]* + +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)* + +
+ +# Interface: JSONRPCResponseError + + +## Properties + +### code + +• **code**: *number* + +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* + +___ + +### message + +• **message**: *string* + +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)* + +
+ +# Interface: JSONRPCResponsePayload + + +## Properties + +### `Optional` error + +• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* + +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* + +___ + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* + +___ + +### result + +• **result**: *any* + +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)* + +
+ +# Interface: LogEntry + + +## Properties + +### address + +• **address**: *string* + +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* + +___ + +### blockHash + +• **blockHash**: *string | null* + +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* + +___ + +### blockNumber + +• **blockNumber**: *number | null* + +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* + +___ + +### data + +• **data**: *string* + +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* + +___ + +### logIndex + +• **logIndex**: *number | null* + +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* + +___ + +### topics + +• **topics**: *string[]* + +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* + +___ + +### transactionIndex + +• **transactionIndex**: *number | null* + +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)* + +
+ +# Interface: LogEntryEvent + + +## Properties + +### address + +• **address**: *string* + +*Inherited from [LogEntry](#interface-logentry).[address](#address)* + +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* + +___ + +### blockHash + +• **blockHash**: *string | null* + +*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* + +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* + +___ + +### blockNumber + +• **blockNumber**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* + +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* + +___ + +### data + +• **data**: *string* + +*Inherited from [LogEntry](#interface-logentry).[data](#data)* + +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* + +___ + +### logIndex + +• **logIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* + +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* + +___ + +### removed + +• **removed**: *boolean* + +*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L425)* + +___ + +### topics + +• **topics**: *string[]* + +*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* + +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* + +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* + +___ + +### transactionIndex + +• **transactionIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* + +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)* + +
+ +# Interface: LogWithDecodedArgs <**ArgsType**> + +## Type parameters + +▪ **ArgsType**: *[DecodedLogArgs](#class-decodedlogargs)* + + +## Properties + +### address + +• **address**: *string* + +*Inherited from [LogEntry](#interface-logentry).[address](#address)* + +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* + +___ + +### args + +• **args**: *`ArgsType`* + +*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* + +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* + +___ + +### blockHash + +• **blockHash**: *string | null* + +*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* + +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* + +___ + +### blockNumber + +• **blockNumber**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* + +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* + +___ + +### data + +• **data**: *string* + +*Inherited from [LogEntry](#interface-logentry).[data](#data)* + +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* + +___ + +### event + +• **event**: *string* + +*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* + +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* + +___ + +### logIndex + +• **logIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* + +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* + +___ + +### topics + +• **topics**: *string[]* + +*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* + +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* + +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* + +___ + +### transactionIndex + +• **transactionIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* + +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)* + +
+ +# Interface: MethodAbi + + +## Properties + +### constant + +• **constant**: *boolean* + +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L94)* + +___ + +### inputs + +• **inputs**: *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L92)* + +___ + +### name + +• **name**: *string* + +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L91)* + +___ + +### outputs + +• **outputs**: *[DataItem](#class-dataitem)[]* + +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L93)* + +___ + +### payable + +• **payable**: *boolean* + +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L96)* + +___ + +### stateMutability + +• **stateMutability**: *[StateMutability](#statemutability)* + +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L95)* + +___ + +### type + +• **type**: *string* + +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L90)* + +
+ +# Interface: OptimizerSettings + + +## Properties + +### enabled + +• **enabled**: *boolean* + +*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L708)* + +___ + +### `Optional` runs + +• **runs**? : *undefined | number* + +*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L709)* + +
+ + + # Interface: RevertErrorAbi @@ -21016,7 +31202,7 @@ EIP712 hash of the transaction with the domain separator of this contract. • **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L122)* +*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L122)* ___ @@ -21024,7 +31210,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L121)* +*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L121)* ___ @@ -21032,7 +31218,7 @@ ___ • **type**: *"error"* -*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L120)* +*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L120)*
@@ -21051,7 +31237,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L564)* +*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L564)* ___ @@ -21059,7 +31245,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L566)* +*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L566)* ___ @@ -21067,7 +31253,7 @@ ___ • **evm**: *[EvmOutput](#class-evmoutput)* -*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L565)* +*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L565)*
@@ -21096,7 +31282,7 @@ ___ *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/44793a9cf/packages/ethereum-types/src/index.ts#L141)* +*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L141)* ___ @@ -21106,7 +31292,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -21116,7 +31302,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -21131,7 +31317,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -21139,7 +31325,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -21149,7 +31335,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -21159,7 +31345,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -21169,7 +31355,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -21179,7 +31365,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -21189,7 +31375,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
@@ -21204,7 +31390,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -21214,7 +31400,7 @@ ___ *Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -21224,7 +31410,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -21234,7 +31420,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -21244,7 +31430,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -21254,7 +31440,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -21264,7 +31450,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/44793a9cf/packages/ethereum-types/src/index.ts#L442)* +*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L442)*
@@ -21281,7 +31467,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/44793a9cf/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -21297,7 +31483,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/44793a9cf/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -21323,7 +31509,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/44793a9cf/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -21349,7 +31535,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/44793a9cf/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -21375,7 +31561,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ @@ -21383,7 +31569,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ @@ -21391,7 +31577,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -21399,7 +31585,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -21409,7 +31595,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/44793a9cf/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -21426,7 +31612,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -21442,47 +31628,6 @@ ___ -# 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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/types/src/index.ts#L878)* - -
- @@ -21506,7 +31651,7 @@ ___ • **isRemoved**: *boolean* -*Defined in [types/src/index.ts:844](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L844)* +*Defined in [types/src/index.ts:853](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L853)* ___ @@ -21514,7 +31659,7 @@ ___ • **log**: *`LogWithDecodedArgs`* -*Defined in [types/src/index.ts:845](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L845)* +*Defined in [types/src/index.ts:854](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L854)*
@@ -21535,7 +31680,7 @@ ___ • **chainId**: *number* -*Defined in [types/src/index.ts:793](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L793)* +*Defined in [types/src/index.ts:802](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L802)* ___ @@ -21543,7 +31688,7 @@ ___ • **name**? : *undefined | string* -*Defined in [types/src/index.ts:791](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L791)* +*Defined in [types/src/index.ts:800](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L800)* ___ @@ -21551,7 +31696,7 @@ ___ • **verifyingContract**: *string* -*Defined in [types/src/index.ts:794](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L794)* +*Defined in [types/src/index.ts:803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L803)* ___ @@ -21559,7 +31704,7 @@ ___ • **version**? : *undefined | string* -*Defined in [types/src/index.ts:792](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L792)* +*Defined in [types/src/index.ts:801](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L801)*
@@ -21601,7 +31746,7 @@ ___ • **keyName**: *string* -*Defined in [types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L691)* +*Defined in [types/src/index.ts:679](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L679)* ___ @@ -21609,7 +31754,7 @@ ___ • **keyType**: *[Type](#class-type)* -*Defined in [types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L692)* +*Defined in [types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L680)* ___ @@ -21617,7 +31762,7 @@ ___ • **valueName**: *string* -*Defined in [types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L693)* +*Defined in [types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L681)*
@@ -21664,45 +31809,6 @@ ___ - -# 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/44793a9cf/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/44793a9cf/packages/types/src/index.ts#L680)* - -*Defined in [types/src/index.ts:868](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/packages/types/src/index.ts#L682)* - -
# Interface: SignedOrder @@ -21715,7 +31821,7 @@ ___ *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* ___ @@ -21725,7 +31831,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -21735,7 +31841,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -21745,7 +31851,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -21755,7 +31861,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -21765,7 +31871,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -21775,7 +31881,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -21785,7 +31891,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* ___ @@ -21795,7 +31901,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -21805,7 +31911,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -21815,7 +31921,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -21823,7 +31929,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -21833,7 +31939,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -21843,7 +31949,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -21853,7 +31959,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -21863,7 +31969,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* ___ @@ -21873,7 +31979,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -21888,7 +31994,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* ___ @@ -21898,7 +32004,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[domain](#domain)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* ___ @@ -21908,7 +32014,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* ___ @@ -21918,7 +32024,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[gasPrice](#gasprice)* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* ___ @@ -21928,7 +32034,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* ___ @@ -21936,7 +32042,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L54)* +*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L54)* ___ @@ -21946,7 +32052,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L48)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)*
@@ -21959,7 +32065,7 @@ ___ • **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)* -*Defined in [types/src/index.ts:884](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L884)* +*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L748)* ___ @@ -21967,7 +32073,7 @@ ___ • **contractName**: *string* -*Defined in [types/src/index.ts:883](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L883)* +*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L747)* ___ @@ -21975,7 +32081,7 @@ ___ • **networks**: *`ContractNetworks`* -*Defined in [types/src/index.ts:885](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L885)* +*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L749)* ___ @@ -21983,7 +32089,7 @@ ___ • **schemaVersion**: *string* -*Defined in [types/src/index.ts:882](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L882)* +*Defined in [types/src/index.ts:746](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L746)*
@@ -21996,7 +32102,7 @@ ___ • **object**: *string* -*Defined in [types/src/index.ts:899](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L899)* +*Defined in [types/src/index.ts:763](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L763)*
@@ -22009,7 +32115,7 @@ ___ • **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)* -*Defined in [types/src/index.ts:895](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L895)* +*Defined in [types/src/index.ts:759](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L759)*
@@ -22022,7 +32128,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [types/src/index.ts:889](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L889)* +*Defined in [types/src/index.ts:753](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L753)* ___ @@ -22030,7 +32136,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [types/src/index.ts:891](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L891)* +*Defined in [types/src/index.ts:755](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L755)* ___ @@ -22038,7 +32144,7 @@ ___ • **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)* -*Defined in [types/src/index.ts:890](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L890)* +*Defined in [types/src/index.ts:754](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L754)*
@@ -22087,7 +32193,7 @@ ZeroExTransaction for use with 0x Exchange executeTransaction • **data**: *string* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* ___ @@ -22095,7 +32201,7 @@ ___ • **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* ___ @@ -22103,7 +32209,7 @@ ___ • **expirationTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* ___ @@ -22111,7 +32217,7 @@ ___ • **gasPrice**: *`BigNumber`* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* ___ @@ -22119,7 +32225,7 @@ ___ • **salt**: *`BigNumber`* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* ___ @@ -22127,56 +32233,12 @@ ___ • **signerAddress**: *string* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L48)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)*
- -## Type aliases - - - - - - - - - - - -### EventCallback - -Ƭ **EventCallback**: *function* - -*Defined in [types/src/index.ts:848](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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`*› | - -___ - - - - - - - - - - - - -
@@ -22188,7 +32250,7 @@ ___ Ƭ **CoordinatorRegistryEventArgs**: *[CoordinatorRegistryCoordinatorEndpointSetEventArgs](#interface-coordinatorregistrycoordinatorendpointseteventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L28)*
@@ -22205,7 +32267,7 @@ ___ Ƭ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L28)*
@@ -22218,7 +32280,7 @@ ___ Ƭ **DummyERC721TokenEventArgs**: *[DummyERC721TokenApprovalEventArgs](#interface-dummyerc721tokenapprovaleventargs) | [DummyERC721TokenApprovalForAllEventArgs](#interface-dummyerc721tokenapprovalforalleventargs) | [DummyERC721TokenTransferEventArgs](#interface-dummyerc721tokentransfereventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L28)*
@@ -22235,7 +32297,7 @@ ___ Ƭ **ERC1155ProxyEventArgs**: *[ERC1155ProxyAuthorizedAddressAddedEventArgs](#interface-erc1155proxyauthorizedaddressaddedeventargs) | [ERC1155ProxyAuthorizedAddressRemovedEventArgs](#interface-erc1155proxyauthorizedaddressremovedeventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L28)*
@@ -22248,7 +32310,7 @@ ___ Ƭ **ERC20ProxyEventArgs**: *[ERC20ProxyAuthorizedAddressAddedEventArgs](#interface-erc20proxyauthorizedaddressaddedeventargs) | [ERC20ProxyAuthorizedAddressRemovedEventArgs](#interface-erc20proxyauthorizedaddressremovedeventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L28)*
@@ -22261,7 +32323,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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L28)*
@@ -22274,7 +32336,7 @@ ___ Ƭ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L28)*
@@ -22287,7 +32349,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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L28)*
@@ -22300,7 +32362,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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L28)*
@@ -22329,7 +32391,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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L28)*
@@ -22342,7 +32404,7 @@ ___ Ƭ **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/44793a9cf/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L28)*
@@ -22355,7 +32417,7 @@ ___ ▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)* -*Defined in [contract-addresses/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L164)* +*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L128)* Used to get addresses of contracts that have been deployed to either the Ethereum mainnet or a supported testnet. Throws if there are no known @@ -22395,7 +32457,7 @@ given networkId. Ƭ **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/44793a9cf/packages/ethereum-types/src/index.ts#L80)* +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L80)* ___ @@ -22403,7 +32465,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L483)* +*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L483)* ___ @@ -22411,7 +32473,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L84)* ___ @@ -22419,7 +32481,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L78)* +*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L78)* ___ @@ -22427,7 +32489,7 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L468)* +*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L468)* ___ @@ -22437,7 +32499,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -22452,7 +32514,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/44793a9cf/packages/ethereum-types/src/index.ts#L82)* +*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L82)* ___ @@ -22460,7 +32522,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -22481,7 +32543,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/44793a9cf/packages/ethereum-types/src/index.ts#L525)* +*Defined in [ethereum-types/src/index.ts:525](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L525)* ___ @@ -22489,7 +32551,7 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L561)* +*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L561)* ___ @@ -22497,7 +32559,7 @@ ___ Ƭ **RawLog**: *[LogEntry](#interface-logentry)* -*Defined in [ethereum-types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L475)* +*Defined in [ethereum-types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L475)* ___ @@ -22505,7 +32567,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L85)* ___ @@ -22513,7 +32575,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/44793a9cf/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -22528,7 +32590,55 @@ ___ Ƭ **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/44793a9cf/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)*
+ + + +## Type aliases + + + + + + + + + + + +### EventCallback + +Ƭ **EventCallback**: *function* + +*Defined in [types/src/index.ts:857](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L857)* + +#### 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 eec56c698d..cbaad0fafc 100644 --- a/packages/contracts-gen/CHANGELOG.json +++ b/packages/contracts-gen/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "1.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "1.1.0-beta.0", "changes": [ diff --git a/packages/contracts-gen/CHANGELOG.md b/packages/contracts-gen/CHANGELOG.md index 64d6294759..874b994727 100644 --- a/packages/contracts-gen/CHANGELOG.md +++ b/packages/contracts-gen/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v1.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v1.1.0-beta.0 - _October 3, 2019_ * Generate boilerplate for all contracts if none are specified or if all contracts identifier is used (#2055) diff --git a/packages/dev-utils/CHANGELOG.json b/packages/dev-utils/CHANGELOG.json index fb9023ef19..61e1e91d6e 100644 --- a/packages/dev-utils/CHANGELOG.json +++ b/packages/dev-utils/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.4.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.4.0-beta.0", "changes": [ diff --git a/packages/dev-utils/CHANGELOG.md b/packages/dev-utils/CHANGELOG.md index bdf9fa4cee..fa74ba77b1 100644 --- a/packages/dev-utils/CHANGELOG.md +++ b/packages/dev-utils/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.4.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.4.0-beta.0 - _October 3, 2019_ * `revertWith` mocha extensions now accept Promise-like objects instead of just Promises (#2031) diff --git a/packages/ethereum-types/CHANGELOG.json b/packages/ethereum-types/CHANGELOG.json index 42a512a86c..7abc500967 100644 --- a/packages/ethereum-types/CHANGELOG.json +++ b/packages/ethereum-types/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.2.0-beta.0", "changes": [ diff --git a/packages/ethereum-types/CHANGELOG.md b/packages/ethereum-types/CHANGELOG.md index ca53461d98..152485e402 100644 --- a/packages/ethereum-types/CHANGELOG.md +++ b/packages/ethereum-types/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.2.0-beta.0 - _October 3, 2019_ * Add `RevertErrorAbi` interface as part of `AbiDefinition` types (#1761) diff --git a/packages/ethereum-types/docs/reference.mdx b/packages/ethereum-types/docs/reference.mdx index 33664058d5..7e66f9c26b 100644 --- a/packages/ethereum-types/docs/reference.mdx +++ b/packages/ethereum-types/docs/reference.mdx @@ -1,22 +1,37 @@ -# 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/44793a9cf/packages/ethereum-types/src/index.ts#L14)* +*Defined in [index.ts:463](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L463)* -**Parameters:** +___ -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | +### Event -**Returns:** *void* +• **Event**: = "event" + +*Defined in [index.ts:464](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L464)* + +___ + +### Fallback + +• **Fallback**: = "fallback" + +*Defined in [index.ts:465](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L465)* + +___ + +### Function + +• **Function**: = "function" + +*Defined in [index.ts:462](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L462)*
@@ -29,7 +44,7 @@ Name | Type | • **Earliest**: = "earliest" -*Defined in [index.ts:478](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L478)* +*Defined in [index.ts:478](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L478)* ___ @@ -37,7 +52,7 @@ ___ • **Latest**: = "latest" -*Defined in [index.ts:479](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L479)* +*Defined in [index.ts:479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L479)* ___ @@ -45,7 +60,7 @@ ___ • **Pending**: = "pending" -*Defined in [index.ts:480](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L480)* +*Defined in [index.ts:480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L480)*
@@ -58,7 +73,7 @@ ___ • **Add**: = "ADD" -*Defined in [index.ts:147](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L147)* +*Defined in [index.ts:147](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L147)* ___ @@ -66,7 +81,7 @@ ___ • **AddMod**: = "ADDMOD" -*Defined in [index.ts:154](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L154)* +*Defined in [index.ts:154](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L154)* ___ @@ -74,7 +89,7 @@ ___ • **Address**: = "ADDRESS" -*Defined in [index.ts:173](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L173)* +*Defined in [index.ts:173](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L173)* ___ @@ -82,7 +97,7 @@ ___ • **And**: = "AND" -*Defined in [index.ts:165](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L165)* +*Defined in [index.ts:165](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L165)* ___ @@ -90,7 +105,7 @@ ___ • **Balance**: = "BALANCE" -*Defined in [index.ts:174](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L174)* +*Defined in [index.ts:174](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L174)* ___ @@ -98,7 +113,7 @@ ___ • **BlockHash**: = "BLOCKHASH" -*Defined in [index.ts:189](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L189)* +*Defined in [index.ts:189](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L189)* ___ @@ -106,7 +121,7 @@ ___ • **Byte**: = "BYTE" -*Defined in [index.ts:169](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L169)* +*Defined in [index.ts:169](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L169)* ___ @@ -114,7 +129,7 @@ ___ • **Call**: = "CALL" -*Defined in [index.ts:282](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L282)* +*Defined in [index.ts:282](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L282)* ___ @@ -122,7 +137,7 @@ ___ • **CallCode**: = "CALLCODE" -*Defined in [index.ts:283](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L283)* +*Defined in [index.ts:283](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L283)* ___ @@ -130,7 +145,7 @@ ___ • **CallDataCopy**: = "CALLDATACOPY" -*Defined in [index.ts:180](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L180)* +*Defined in [index.ts:180](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L180)* ___ @@ -138,7 +153,7 @@ ___ • **CallDataLoad**: = "CALLDATALOAD" -*Defined in [index.ts:178](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L178)* +*Defined in [index.ts:178](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L178)* ___ @@ -146,7 +161,7 @@ ___ • **CallDataSize**: = "CALLDATASIZE" -*Defined in [index.ts:179](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L179)* +*Defined in [index.ts:179](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L179)* ___ @@ -154,7 +169,7 @@ ___ • **CallValue**: = "CALLVALUE" -*Defined in [index.ts:177](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L177)* +*Defined in [index.ts:177](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L177)* ___ @@ -162,7 +177,7 @@ ___ • **Caller**: = "CALLER" -*Defined in [index.ts:176](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L176)* +*Defined in [index.ts:176](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L176)* ___ @@ -170,7 +185,7 @@ ___ • **CodeCopy**: = "CODECOPY" -*Defined in [index.ts:182](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L182)* +*Defined in [index.ts:182](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L182)* ___ @@ -178,7 +193,7 @@ ___ • **CodeSize**: = "CODESIZE" -*Defined in [index.ts:181](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L181)* +*Defined in [index.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L181)* ___ @@ -186,7 +201,7 @@ ___ • **Coinbase**: = "COINBASE" -*Defined in [index.ts:190](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L190)* +*Defined in [index.ts:190](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L190)* ___ @@ -194,7 +209,7 @@ ___ • **Create**: = "CREATE" -*Defined in [index.ts:281](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L281)* +*Defined in [index.ts:281](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L281)* ___ @@ -202,7 +217,7 @@ ___ • **DelegateCall**: = "DELEGATECALL" -*Defined in [index.ts:285](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L285)* +*Defined in [index.ts:285](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L285)* ___ @@ -210,7 +225,7 @@ ___ • **Difficulty**: = "DIFFICULTY" -*Defined in [index.ts:193](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L193)* +*Defined in [index.ts:193](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L193)* ___ @@ -218,7 +233,7 @@ ___ • **Div**: = "DIV" -*Defined in [index.ts:150](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L150)* +*Defined in [index.ts:150](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L150)* ___ @@ -226,7 +241,7 @@ ___ • **Dup1**: = "DUP1" -*Defined in [index.ts:242](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L242)* +*Defined in [index.ts:242](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L242)* ___ @@ -234,7 +249,7 @@ ___ • **Dup10**: = "DUP10" -*Defined in [index.ts:251](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L251)* +*Defined in [index.ts:251](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L251)* ___ @@ -242,7 +257,7 @@ ___ • **Dup11**: = "DUP11" -*Defined in [index.ts:252](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L252)* +*Defined in [index.ts:252](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L252)* ___ @@ -250,7 +265,7 @@ ___ • **Dup12**: = "DUP12" -*Defined in [index.ts:253](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L253)* +*Defined in [index.ts:253](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L253)* ___ @@ -258,7 +273,7 @@ ___ • **Dup13**: = "DUP13" -*Defined in [index.ts:254](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L254)* +*Defined in [index.ts:254](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L254)* ___ @@ -266,7 +281,7 @@ ___ • **Dup14**: = "DUP14" -*Defined in [index.ts:255](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L255)* +*Defined in [index.ts:255](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L255)* ___ @@ -274,7 +289,7 @@ ___ • **Dup15**: = "DUP15" -*Defined in [index.ts:256](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L256)* +*Defined in [index.ts:256](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L256)* ___ @@ -282,7 +297,7 @@ ___ • **Dup16**: = "DUP16" -*Defined in [index.ts:257](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L257)* +*Defined in [index.ts:257](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L257)* ___ @@ -290,7 +305,7 @@ ___ • **Dup2**: = "DUP2" -*Defined in [index.ts:243](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L243)* +*Defined in [index.ts:243](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L243)* ___ @@ -298,7 +313,7 @@ ___ • **Dup3**: = "DUP3" -*Defined in [index.ts:244](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L244)* +*Defined in [index.ts:244](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L244)* ___ @@ -306,7 +321,7 @@ ___ • **Dup4**: = "DUP4" -*Defined in [index.ts:245](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L245)* +*Defined in [index.ts:245](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L245)* ___ @@ -314,7 +329,7 @@ ___ • **Dup5**: = "DUP5" -*Defined in [index.ts:246](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L246)* +*Defined in [index.ts:246](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L246)* ___ @@ -322,7 +337,7 @@ ___ • **Dup6**: = "DUP6" -*Defined in [index.ts:247](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L247)* +*Defined in [index.ts:247](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L247)* ___ @@ -330,7 +345,7 @@ ___ • **Dup7**: = "DUP7" -*Defined in [index.ts:248](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L248)* +*Defined in [index.ts:248](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L248)* ___ @@ -338,7 +353,7 @@ ___ • **Dup8**: = "DUP8" -*Defined in [index.ts:249](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L249)* +*Defined in [index.ts:249](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L249)* ___ @@ -346,7 +361,7 @@ ___ • **Dup9**: = "DUP9" -*Defined in [index.ts:250](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L250)* +*Defined in [index.ts:250](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L250)* ___ @@ -354,7 +369,7 @@ ___ • **Eq**: = "EQ" -*Defined in [index.ts:163](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L163)* +*Defined in [index.ts:163](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L163)* ___ @@ -362,7 +377,7 @@ ___ • **Exp**: = "EXP" -*Defined in [index.ts:156](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L156)* +*Defined in [index.ts:156](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L156)* ___ @@ -370,7 +385,7 @@ ___ • **ExtCodeCopy**: = "EXTCODECOPY" -*Defined in [index.ts:185](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L185)* +*Defined in [index.ts:185](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L185)* ___ @@ -378,7 +393,7 @@ ___ • **ExtCodeSize**: = "EXTCODESIZE" -*Defined in [index.ts:184](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L184)* +*Defined in [index.ts:184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L184)* ___ @@ -386,7 +401,7 @@ ___ • **Gas**: = "GAS" -*Defined in [index.ts:206](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L206)* +*Defined in [index.ts:206](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L206)* ___ @@ -394,7 +409,7 @@ ___ • **GasPrice**: = "GASPRICE" -*Defined in [index.ts:183](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L183)* +*Defined in [index.ts:183](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L183)* ___ @@ -402,7 +417,7 @@ ___ • **Gaslimit**: = "GASLIMIT" -*Defined in [index.ts:194](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L194)* +*Defined in [index.ts:194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L194)* ___ @@ -410,7 +425,7 @@ ___ • **Gt**: = "GT" -*Defined in [index.ts:160](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L160)* +*Defined in [index.ts:160](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L160)* ___ @@ -418,7 +433,7 @@ ___ • **Invalid**: = "INVALID" -*Defined in [index.ts:288](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L288)* +*Defined in [index.ts:288](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L288)* ___ @@ -426,7 +441,7 @@ ___ • **IsZero**: = "ISZERO" -*Defined in [index.ts:164](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L164)* +*Defined in [index.ts:164](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L164)* ___ @@ -434,7 +449,7 @@ ___ • **Jump**: = "JUMP" -*Defined in [index.ts:202](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L202)* +*Defined in [index.ts:202](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L202)* ___ @@ -442,7 +457,7 @@ ___ • **JumpDest**: = "JUMPDEST" -*Defined in [index.ts:207](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L207)* +*Defined in [index.ts:207](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L207)* ___ @@ -450,7 +465,7 @@ ___ • **Jumpi**: = "JUMPI" -*Defined in [index.ts:203](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L203)* +*Defined in [index.ts:203](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L203)* ___ @@ -458,7 +473,7 @@ ___ • **Log1**: = "LOG1" -*Defined in [index.ts:276](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L276)* +*Defined in [index.ts:276](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L276)* ___ @@ -466,7 +481,7 @@ ___ • **Log2**: = "LOG2" -*Defined in [index.ts:277](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L277)* +*Defined in [index.ts:277](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L277)* ___ @@ -474,7 +489,7 @@ ___ • **Log3**: = "LOG3" -*Defined in [index.ts:278](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L278)* +*Defined in [index.ts:278](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L278)* ___ @@ -482,7 +497,7 @@ ___ • **Log4**: = "LOG4" -*Defined in [index.ts:279](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L279)* +*Defined in [index.ts:279](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L279)* ___ @@ -490,7 +505,7 @@ ___ • **Lt**: = "LT" -*Defined in [index.ts:159](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L159)* +*Defined in [index.ts:159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L159)* ___ @@ -498,7 +513,7 @@ ___ • **MLoad**: = "MLOAD" -*Defined in [index.ts:197](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L197)* +*Defined in [index.ts:197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L197)* ___ @@ -506,7 +521,7 @@ ___ • **MSize**: = "MSIZE" -*Defined in [index.ts:205](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L205)* +*Defined in [index.ts:205](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L205)* ___ @@ -514,7 +529,7 @@ ___ • **MStore**: = "MSTORE" -*Defined in [index.ts:198](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L198)* +*Defined in [index.ts:198](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L198)* ___ @@ -522,7 +537,7 @@ ___ • **MStore8**: = "MSTORE8" -*Defined in [index.ts:199](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L199)* +*Defined in [index.ts:199](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L199)* ___ @@ -530,7 +545,7 @@ ___ • **Mod**: = "MOD" -*Defined in [index.ts:152](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L152)* +*Defined in [index.ts:152](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L152)* ___ @@ -538,7 +553,7 @@ ___ • **Mul**: = "MUL" -*Defined in [index.ts:148](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L148)* +*Defined in [index.ts:148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L148)* ___ @@ -546,7 +561,7 @@ ___ • **MulMod**: = "MULMOD" -*Defined in [index.ts:155](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L155)* +*Defined in [index.ts:155](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L155)* ___ @@ -554,7 +569,7 @@ ___ • **Not**: = "NOT" -*Defined in [index.ts:168](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L168)* +*Defined in [index.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L168)* ___ @@ -562,7 +577,7 @@ ___ • **Number**: = "NUMBER" -*Defined in [index.ts:192](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L192)* +*Defined in [index.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L192)* ___ @@ -570,7 +585,7 @@ ___ • **Or**: = "OR" -*Defined in [index.ts:166](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L166)* +*Defined in [index.ts:166](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L166)* ___ @@ -578,7 +593,7 @@ ___ • **Origin**: = "ORIGIN" -*Defined in [index.ts:175](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L175)* +*Defined in [index.ts:175](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L175)* ___ @@ -586,7 +601,7 @@ ___ • **Pc**: = "PC" -*Defined in [index.ts:204](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L204)* +*Defined in [index.ts:204](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L204)* ___ @@ -594,7 +609,7 @@ ___ • **Pop**: = "POP" -*Defined in [index.ts:196](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L196)* +*Defined in [index.ts:196](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L196)* ___ @@ -602,7 +617,7 @@ ___ • **Push1**: = "PUSH1" -*Defined in [index.ts:209](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L209)* +*Defined in [index.ts:209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L209)* ___ @@ -610,7 +625,7 @@ ___ • **Push10**: = "PUSH10" -*Defined in [index.ts:218](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L218)* +*Defined in [index.ts:218](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L218)* ___ @@ -618,7 +633,7 @@ ___ • **Push11**: = "PUSH11" -*Defined in [index.ts:219](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L219)* +*Defined in [index.ts:219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L219)* ___ @@ -626,7 +641,7 @@ ___ • **Push12**: = "PUSH12" -*Defined in [index.ts:220](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L220)* +*Defined in [index.ts:220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L220)* ___ @@ -634,7 +649,7 @@ ___ • **Push13**: = "PUSH13" -*Defined in [index.ts:221](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L221)* +*Defined in [index.ts:221](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L221)* ___ @@ -642,7 +657,7 @@ ___ • **Push14**: = "PUSH14" -*Defined in [index.ts:222](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L222)* +*Defined in [index.ts:222](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L222)* ___ @@ -650,7 +665,7 @@ ___ • **Push15**: = "PUSH15" -*Defined in [index.ts:223](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L223)* +*Defined in [index.ts:223](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L223)* ___ @@ -658,7 +673,7 @@ ___ • **Push16**: = "PUSH16" -*Defined in [index.ts:224](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L224)* +*Defined in [index.ts:224](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L224)* ___ @@ -666,7 +681,7 @@ ___ • **Push17**: = "PUSH17" -*Defined in [index.ts:225](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L225)* +*Defined in [index.ts:225](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L225)* ___ @@ -674,7 +689,7 @@ ___ • **Push18**: = "PUSH18" -*Defined in [index.ts:226](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L226)* +*Defined in [index.ts:226](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L226)* ___ @@ -682,7 +697,7 @@ ___ • **Push19**: = "PUSH19" -*Defined in [index.ts:227](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L227)* +*Defined in [index.ts:227](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L227)* ___ @@ -690,7 +705,7 @@ ___ • **Push2**: = "PUSH2" -*Defined in [index.ts:210](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L210)* +*Defined in [index.ts:210](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L210)* ___ @@ -698,7 +713,7 @@ ___ • **Push20**: = "PUSH20" -*Defined in [index.ts:228](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L228)* +*Defined in [index.ts:228](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L228)* ___ @@ -706,7 +721,7 @@ ___ • **Push21**: = "PUSH21" -*Defined in [index.ts:229](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L229)* +*Defined in [index.ts:229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L229)* ___ @@ -714,7 +729,7 @@ ___ • **Push22**: = "PUSH22" -*Defined in [index.ts:230](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L230)* +*Defined in [index.ts:230](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L230)* ___ @@ -722,7 +737,7 @@ ___ • **Push23**: = "PUSH23" -*Defined in [index.ts:231](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L231)* +*Defined in [index.ts:231](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L231)* ___ @@ -730,7 +745,7 @@ ___ • **Push24**: = "PUSH24" -*Defined in [index.ts:232](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L232)* +*Defined in [index.ts:232](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L232)* ___ @@ -738,7 +753,7 @@ ___ • **Push25**: = "PUSH25" -*Defined in [index.ts:233](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L233)* +*Defined in [index.ts:233](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L233)* ___ @@ -746,7 +761,7 @@ ___ • **Push26**: = "PUSH26" -*Defined in [index.ts:234](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L234)* +*Defined in [index.ts:234](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L234)* ___ @@ -754,7 +769,7 @@ ___ • **Push27**: = "PUSH27" -*Defined in [index.ts:235](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L235)* +*Defined in [index.ts:235](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L235)* ___ @@ -762,7 +777,7 @@ ___ • **Push28**: = "PUSH28" -*Defined in [index.ts:236](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L236)* +*Defined in [index.ts:236](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L236)* ___ @@ -770,7 +785,7 @@ ___ • **Push29**: = "PUSH29" -*Defined in [index.ts:237](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L237)* +*Defined in [index.ts:237](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L237)* ___ @@ -778,7 +793,7 @@ ___ • **Push3**: = "PUSH3" -*Defined in [index.ts:211](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L211)* +*Defined in [index.ts:211](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L211)* ___ @@ -786,7 +801,7 @@ ___ • **Push30**: = "PUSH30" -*Defined in [index.ts:238](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L238)* +*Defined in [index.ts:238](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L238)* ___ @@ -794,7 +809,7 @@ ___ • **Push31**: = "PUSH31" -*Defined in [index.ts:239](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L239)* +*Defined in [index.ts:239](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L239)* ___ @@ -802,7 +817,7 @@ ___ • **Push32**: = "PUSH32" -*Defined in [index.ts:240](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L240)* +*Defined in [index.ts:240](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L240)* ___ @@ -810,7 +825,7 @@ ___ • **Push4**: = "PUSH4" -*Defined in [index.ts:212](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L212)* +*Defined in [index.ts:212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L212)* ___ @@ -818,7 +833,7 @@ ___ • **Push5**: = "PUSH5" -*Defined in [index.ts:213](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L213)* +*Defined in [index.ts:213](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L213)* ___ @@ -826,7 +841,7 @@ ___ • **Push6**: = "PUSH6" -*Defined in [index.ts:214](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L214)* +*Defined in [index.ts:214](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L214)* ___ @@ -834,7 +849,7 @@ ___ • **Push7**: = "PUSH7" -*Defined in [index.ts:215](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L215)* +*Defined in [index.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L215)* ___ @@ -842,7 +857,7 @@ ___ • **Push8**: = "PUSH8" -*Defined in [index.ts:216](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L216)* +*Defined in [index.ts:216](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L216)* ___ @@ -850,7 +865,7 @@ ___ • **Push9**: = "PUSH9" -*Defined in [index.ts:217](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L217)* +*Defined in [index.ts:217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L217)* ___ @@ -858,7 +873,7 @@ ___ • **Return**: = "RETURN" -*Defined in [index.ts:284](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L284)* +*Defined in [index.ts:284](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L284)* ___ @@ -866,7 +881,7 @@ ___ • **ReturnDataCopy**: = "RETURNDATACOPY" -*Defined in [index.ts:187](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L187)* +*Defined in [index.ts:187](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L187)* ___ @@ -874,7 +889,7 @@ ___ • **ReturnDataSize**: = "RETURNDATASIZE" -*Defined in [index.ts:186](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L186)* +*Defined in [index.ts:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L186)* ___ @@ -882,7 +897,7 @@ ___ • **Revert**: = "REVERT" -*Defined in [index.ts:287](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L287)* +*Defined in [index.ts:287](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L287)* ___ @@ -890,7 +905,7 @@ ___ • **SDiv**: = "SDIV" -*Defined in [index.ts:151](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L151)* +*Defined in [index.ts:151](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L151)* ___ @@ -898,7 +913,7 @@ ___ • **SGt**: = "SGT" -*Defined in [index.ts:162](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L162)* +*Defined in [index.ts:162](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L162)* ___ @@ -906,7 +921,7 @@ ___ • **SLoad**: = "SLOAD" -*Defined in [index.ts:200](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L200)* +*Defined in [index.ts:200](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L200)* ___ @@ -914,7 +929,7 @@ ___ • **SLt**: = "SLT" -*Defined in [index.ts:161](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L161)* +*Defined in [index.ts:161](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L161)* ___ @@ -922,7 +937,7 @@ ___ • **SMod**: = "SMOD" -*Defined in [index.ts:153](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L153)* +*Defined in [index.ts:153](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L153)* ___ @@ -930,7 +945,7 @@ ___ • **SStore**: = "SSTORE" -*Defined in [index.ts:201](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L201)* +*Defined in [index.ts:201](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L201)* ___ @@ -938,7 +953,7 @@ ___ • **SelfDestruct**: = "SELFDESTRUCT" -*Defined in [index.ts:289](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L289)* +*Defined in [index.ts:289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L289)* ___ @@ -946,7 +961,7 @@ ___ • **Sha3**: = "SHA3" -*Defined in [index.ts:171](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L171)* +*Defined in [index.ts:171](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L171)* ___ @@ -954,7 +969,7 @@ ___ • **SignExtend**: = "SIGNEXTEND" -*Defined in [index.ts:157](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L157)* +*Defined in [index.ts:157](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L157)* ___ @@ -962,7 +977,7 @@ ___ • **StaticCall**: = "STATICCALL" -*Defined in [index.ts:286](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L286)* +*Defined in [index.ts:286](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L286)* ___ @@ -970,7 +985,7 @@ ___ • **Stop**: = "STOP" -*Defined in [index.ts:146](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L146)* +*Defined in [index.ts:146](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L146)* ___ @@ -978,7 +993,7 @@ ___ • **Sub**: = "SUB" -*Defined in [index.ts:149](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L149)* +*Defined in [index.ts:149](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L149)* ___ @@ -986,7 +1001,7 @@ ___ • **Swap1**: = "SWAP1" -*Defined in [index.ts:259](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L259)* +*Defined in [index.ts:259](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L259)* ___ @@ -994,7 +1009,7 @@ ___ • **Swap10**: = "SWAP10" -*Defined in [index.ts:268](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L268)* +*Defined in [index.ts:268](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L268)* ___ @@ -1002,7 +1017,7 @@ ___ • **Swap11**: = "SWAP11" -*Defined in [index.ts:269](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L269)* +*Defined in [index.ts:269](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L269)* ___ @@ -1010,7 +1025,7 @@ ___ • **Swap12**: = "SWAP12" -*Defined in [index.ts:270](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L270)* +*Defined in [index.ts:270](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L270)* ___ @@ -1018,7 +1033,7 @@ ___ • **Swap13**: = "SWAP13" -*Defined in [index.ts:271](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L271)* +*Defined in [index.ts:271](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L271)* ___ @@ -1026,7 +1041,7 @@ ___ • **Swap14**: = "SWAP14" -*Defined in [index.ts:272](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L272)* +*Defined in [index.ts:272](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L272)* ___ @@ -1034,7 +1049,7 @@ ___ • **Swap15**: = "SWAP15" -*Defined in [index.ts:273](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L273)* +*Defined in [index.ts:273](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L273)* ___ @@ -1042,7 +1057,7 @@ ___ • **Swap16**: = "SWAP16" -*Defined in [index.ts:274](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L274)* +*Defined in [index.ts:274](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L274)* ___ @@ -1050,7 +1065,7 @@ ___ • **Swap2**: = "SWAP2" -*Defined in [index.ts:260](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L260)* +*Defined in [index.ts:260](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L260)* ___ @@ -1058,7 +1073,7 @@ ___ • **Swap3**: = "SWAP3" -*Defined in [index.ts:261](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L261)* +*Defined in [index.ts:261](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L261)* ___ @@ -1066,7 +1081,7 @@ ___ • **Swap4**: = "SWAP4" -*Defined in [index.ts:262](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L262)* +*Defined in [index.ts:262](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L262)* ___ @@ -1074,7 +1089,7 @@ ___ • **Swap5**: = "SWAP5" -*Defined in [index.ts:263](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L263)* +*Defined in [index.ts:263](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L263)* ___ @@ -1082,7 +1097,7 @@ ___ • **Swap6**: = "SWAP6" -*Defined in [index.ts:264](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L264)* +*Defined in [index.ts:264](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L264)* ___ @@ -1090,7 +1105,7 @@ ___ • **Swap7**: = "SWAP7" -*Defined in [index.ts:265](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L265)* +*Defined in [index.ts:265](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L265)* ___ @@ -1098,7 +1113,7 @@ ___ • **Swap8**: = "SWAP8" -*Defined in [index.ts:266](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L266)* +*Defined in [index.ts:266](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L266)* ___ @@ -1106,7 +1121,7 @@ ___ • **Swap9**: = "SWAP9" -*Defined in [index.ts:267](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L267)* +*Defined in [index.ts:267](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L267)* ___ @@ -1114,7 +1129,7 @@ ___ • **TimeStamp**: = "TimeStamp" -*Defined in [index.ts:191](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L191)* +*Defined in [index.ts:191](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L191)* ___ @@ -1122,7 +1137,7 @@ ___ • **Xor**: = "XOR" -*Defined in [index.ts:167](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L167)* +*Defined in [index.ts:167](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L167)*
@@ -1135,7 +1150,7 @@ ___ • **Address**: = "address" -*Defined in [index.ts:497](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L497)* +*Defined in [index.ts:497](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L497)* ___ @@ -1143,7 +1158,7 @@ ___ • **Bool**: = "bool" -*Defined in [index.ts:498](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L498)* +*Defined in [index.ts:498](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L498)* ___ @@ -1151,7 +1166,7 @@ ___ • **Bytes**: = "bytes" -*Defined in [index.ts:499](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L499)* +*Defined in [index.ts:499](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L499)* ___ @@ -1159,7 +1174,7 @@ ___ • **Int**: = "int" -*Defined in [index.ts:500](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L500)* +*Defined in [index.ts:500](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L500)* ___ @@ -1167,7 +1182,7 @@ ___ • **String**: = "string" -*Defined in [index.ts:501](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L501)* +*Defined in [index.ts:501](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L501)* ___ @@ -1175,7 +1190,7 @@ ___ • **Tuple**: = "tuple" -*Defined in [index.ts:502](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L502)* +*Defined in [index.ts:502](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L502)* ___ @@ -1183,7 +1198,7 @@ ___ • **Uint**: = "uint" -*Defined in [index.ts:505](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L505)* +*Defined in [index.ts:505](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L505)* ___ @@ -1191,7 +1206,7 @@ ___ • **Uint256**: = "uint256" -*Defined in [index.ts:503](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L503)* +*Defined in [index.ts:503](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L503)* ___ @@ -1199,7 +1214,7 @@ ___ • **Uint8**: = "uint8" -*Defined in [index.ts:504](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L504)* +*Defined in [index.ts:504](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L504)*
@@ -1212,7 +1227,7 @@ ___ • **difficulty**: *`BigNumber`* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L356)* ___ @@ -1220,7 +1235,7 @@ ___ • **extraData**: *string* -*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L358)* +*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L358)* ___ @@ -1228,7 +1243,7 @@ ___ • **gasLimit**: *number* -*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L360)* +*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L360)* ___ @@ -1236,7 +1251,7 @@ ___ • **gasUsed**: *number* -*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L361)* +*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L361)* ___ @@ -1244,7 +1259,7 @@ ___ • **hash**: *string | null* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L348)* ___ @@ -1252,7 +1267,7 @@ ___ • **logsBloom**: *string | null* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L352)* ___ @@ -1260,7 +1275,7 @@ ___ • **miner**: *string* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L355)* ___ @@ -1268,7 +1283,7 @@ ___ • **nonce**: *string | null* -*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L350)* ___ @@ -1276,7 +1291,7 @@ ___ • **number**: *number | null* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L347)* ___ @@ -1284,7 +1299,7 @@ ___ • **parentHash**: *string* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L349)* ___ @@ -1292,7 +1307,7 @@ ___ • **sha3Uncles**: *string* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L351)* ___ @@ -1300,7 +1315,7 @@ ___ • **size**: *number* -*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L359)* +*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L359)* ___ @@ -1308,7 +1323,7 @@ ___ • **stateRoot**: *string* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L354)* ___ @@ -1316,7 +1331,7 @@ ___ • **timestamp**: *number* -*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L362)* +*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L362)* ___ @@ -1324,7 +1339,7 @@ ___ • **totalDifficulty**: *`BigNumber`* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L357)* ___ @@ -1332,7 +1347,7 @@ ___ • **transactionsRoot**: *string* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L353)* ___ @@ -1340,7 +1355,7 @@ ___ • **uncles**: *string[]* -*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L363)* +*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L363)*
@@ -1353,7 +1368,7 @@ ___ • **fromBlock**: *[BlockParam](#blockparam)* -*Defined in [index.ts:740](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L740)* +*Defined in [index.ts:740](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L740)* ___ @@ -1361,7 +1376,7 @@ ___ • **toBlock**: *[BlockParam](#blockparam)* -*Defined in [index.ts:741](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L741)* +*Defined in [index.ts:741](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L741)*
@@ -1376,7 +1391,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[difficulty](#difficulty)* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L356)* ___ @@ -1386,7 +1401,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[extraData](#extradata)* -*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L358)* +*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L358)* ___ @@ -1396,7 +1411,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasLimit](#gaslimit)* -*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L360)* +*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L360)* ___ @@ -1406,7 +1421,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasUsed](#gasused)* -*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L361)* +*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L361)* ___ @@ -1416,7 +1431,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[hash](#hash)* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L348)* ___ @@ -1426,7 +1441,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[logsBloom](#logsbloom)* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L352)* ___ @@ -1436,7 +1451,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[miner](#miner)* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L355)* ___ @@ -1446,7 +1461,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[nonce](#nonce)* -*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L350)* ___ @@ -1456,7 +1471,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[number](#number)* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L347)* ___ @@ -1466,7 +1481,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[parentHash](#parenthash)* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L349)* ___ @@ -1476,7 +1491,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[sha3Uncles](#sha3uncles)* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L351)* ___ @@ -1486,7 +1501,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[size](#size)* -*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L359)* +*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L359)* ___ @@ -1496,7 +1511,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[stateRoot](#stateroot)* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L354)* ___ @@ -1506,7 +1521,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[timestamp](#timestamp)* -*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L362)* +*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L362)* ___ @@ -1516,7 +1531,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[totalDifficulty](#totaldifficulty)* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L357)* ___ @@ -1524,7 +1539,7 @@ ___ • **transactions**: *string[]* -*Defined in [index.ts:367](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L367)* +*Defined in [index.ts:367](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L367)* ___ @@ -1534,7 +1549,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[transactionsRoot](#transactionsroot)* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L353)* ___ @@ -1544,7 +1559,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[uncles](#uncles)* -*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L363)* +*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L363)*
@@ -1559,7 +1574,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[difficulty](#difficulty)* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L356)* ___ @@ -1569,7 +1584,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[extraData](#extradata)* -*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L358)* +*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L358)* ___ @@ -1579,7 +1594,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasLimit](#gaslimit)* -*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L360)* +*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L360)* ___ @@ -1589,7 +1604,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasUsed](#gasused)* -*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L361)* +*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L361)* ___ @@ -1599,7 +1614,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[hash](#hash)* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L348)* ___ @@ -1609,7 +1624,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[logsBloom](#logsbloom)* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L352)* ___ @@ -1619,7 +1634,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[miner](#miner)* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L355)* ___ @@ -1629,7 +1644,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[nonce](#nonce)* -*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L350)* ___ @@ -1639,7 +1654,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[number](#number)* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L347)* ___ @@ -1649,7 +1664,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[parentHash](#parenthash)* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L349)* ___ @@ -1659,7 +1674,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[sha3Uncles](#sha3uncles)* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L351)* ___ @@ -1669,7 +1684,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[size](#size)* -*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L359)* +*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L359)* ___ @@ -1679,7 +1694,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[stateRoot](#stateroot)* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L354)* ___ @@ -1689,7 +1704,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[timestamp](#timestamp)* -*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L362)* +*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L362)* ___ @@ -1699,7 +1714,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[totalDifficulty](#totaldifficulty)* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L357)* ___ @@ -1707,7 +1722,7 @@ ___ • **transactions**: *[Transaction](#class-transaction)[]* -*Defined in [index.ts:371](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L371)* +*Defined in [index.ts:371](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L371)* ___ @@ -1717,7 +1732,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[transactionsRoot](#transactionsroot)* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L353)* ___ @@ -1727,7 +1742,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[uncles](#uncles)* -*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L363)* +*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L363)*
@@ -1742,7 +1757,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -1750,7 +1765,7 @@ ___ • **from**? : *undefined | string* -*Defined in [index.ts:402](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L402)* +*Defined in [index.ts:402](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L402)* ___ @@ -1760,7 +1775,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -1770,7 +1785,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -1780,7 +1795,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -1790,7 +1805,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -1800,7 +1815,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* +*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
@@ -1813,7 +1828,7 @@ ___ • **data**? : *undefined | string* -*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -1821,7 +1836,7 @@ ___ • **gas**? : *number | string | `BigNumber`* -*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -1829,7 +1844,7 @@ ___ • **gasPrice**? : *number | string | `BigNumber`* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -1837,7 +1852,7 @@ ___ • **nonce**? : *undefined | number* -*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -1845,7 +1860,7 @@ ___ • **to**? : *undefined | string* -*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -1853,7 +1868,7 @@ ___ • **value**? : *number | string | `BigNumber`* -*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* +*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
@@ -1878,7 +1893,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/44793a9cf/packages/ethereum-types/src/index.ts#L731)* +*Defined in [index.ts:731](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L731)* ___ @@ -1886,7 +1901,7 @@ ___ • **compilerSettings**? : *[CompilerSettings](#class-compilersettings)* -*Defined in [index.ts:732](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L732)* +*Defined in [index.ts:732](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L732)* ___ @@ -1894,7 +1909,7 @@ ___ • **contracts**? : *string[] | "*"* -*Defined in [index.ts:733](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L733)* +*Defined in [index.ts:733](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L733)* ___ @@ -1902,7 +1917,7 @@ ___ • **contractsDir**? : *undefined | string* -*Defined in [index.ts:730](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L730)* +*Defined in [index.ts:730](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L730)* ___ @@ -1910,7 +1925,7 @@ ___ • **isOfflineMode**? : *undefined | false | true* -*Defined in [index.ts:735](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L735)* +*Defined in [index.ts:735](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L735)* ___ @@ -1918,7 +1933,7 @@ ___ • **solcVersion**? : *undefined | string* -*Defined in [index.ts:736](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L736)* +*Defined in [index.ts:736](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L736)* ___ @@ -1926,7 +1941,7 @@ ___ • **useDockerisedSolc**? : *undefined | false | true* -*Defined in [index.ts:734](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L734)* +*Defined in [index.ts:734](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L734)*
@@ -1939,7 +1954,7 @@ ___ • **name**: *"solc"* -*Defined in [index.ts:655](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L655)* +*Defined in [index.ts:655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L655)* ___ @@ -1947,7 +1962,7 @@ ___ • **settings**: *[CompilerSettings](#class-compilersettings)* -*Defined in [index.ts:657](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L657)* +*Defined in [index.ts:657](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L657)* ___ @@ -1955,7 +1970,7 @@ ___ • **version**: *string* -*Defined in [index.ts:656](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L656)* +*Defined in [index.ts:656](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L656)*
@@ -1968,7 +1983,7 @@ ___ • **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [index.ts:689](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L689)* +*Defined in [index.ts:689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L689)* ___ @@ -1976,7 +1991,7 @@ ___ • **libraries**? : *undefined | object* -*Defined in [index.ts:691](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L691)* +*Defined in [index.ts:691](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L691)* ___ @@ -1984,7 +1999,7 @@ ___ • **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* -*Defined in [index.ts:690](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L690)* +*Defined in [index.ts:690](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L690)* ___ @@ -1992,7 +2007,7 @@ ___ • **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* -*Defined in [index.ts:688](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L688)* +*Defined in [index.ts:688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L688)* ___ @@ -2000,7 +2015,7 @@ ___ • **outputSelection**: *object* -*Defined in [index.ts:696](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L696)* +*Defined in [index.ts:696](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L696)* #### Type declaration: @@ -2014,7 +2029,7 @@ ___ • **remappings**? : *string[]* -*Defined in [index.ts:687](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L687)* +*Defined in [index.ts:687](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L687)*
@@ -2027,7 +2042,7 @@ ___ • **useLiteralContent**: *true* -*Defined in [index.ts:704](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L704)* +*Defined in [index.ts:704](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L704)*
@@ -2040,7 +2055,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L103)* +*Defined in [index.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L103)* ___ @@ -2048,7 +2063,7 @@ ___ • **payable**: *boolean* -*Defined in [index.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L104)* +*Defined in [index.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L104)* ___ @@ -2056,7 +2071,7 @@ ___ • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [index.ts:105](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L105)* +*Defined in [index.ts:105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L105)* ___ @@ -2064,7 +2079,7 @@ ___ • **type**: *string* -*Defined in [index.ts:102](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L102)* +*Defined in [index.ts:102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L102)*
@@ -2091,7 +2106,7 @@ If any of the sources change, the hash would change notifying us that a re-compi *Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* -*Defined in [index.ts:641](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L641)* +*Defined in [index.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L641)* ___ @@ -2101,7 +2116,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* -*Defined in [index.ts:651](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L651)* +*Defined in [index.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L651)* ___ @@ -2109,7 +2124,7 @@ ___ • **contractName**: *string* -*Defined in [index.ts:675](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L675)* +*Defined in [index.ts:675](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L675)* ___ @@ -2117,7 +2132,7 @@ ___ • **networks**: *[ContractNetworks](#class-contractnetworks)* -*Defined in [index.ts:676](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L676)* +*Defined in [index.ts:676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L676)* ___ @@ -2125,7 +2140,7 @@ ___ • **schemaVersion**: *string* -*Defined in [index.ts:674](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L674)* +*Defined in [index.ts:674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L674)* ___ @@ -2135,7 +2150,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* -*Defined in [index.ts:647](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L647)* +*Defined in [index.ts:647](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L647)* #### Type declaration: @@ -2149,7 +2164,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* -*Defined in [index.ts:650](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L650)* +*Defined in [index.ts:650](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L650)* ___ @@ -2159,7 +2174,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* -*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L642)* +*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L642)* #### Type declaration: @@ -2176,7 +2191,7 @@ ___ • **address**: *string* -*Defined in [index.ts:554](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L554)* +*Defined in [index.ts:554](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L554)* ___ @@ -2184,7 +2199,7 @@ Args • **constructorArgs**: *string* -*Defined in [index.ts:558](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L558)* +*Defined in [index.ts:558](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L558)* ___ @@ -2192,7 +2207,7 @@ ___ • **links**: *object* -*Defined in [index.ts:555](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L555)* +*Defined in [index.ts:555](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L555)* #### Type declaration: @@ -2216,7 +2231,7 @@ ___ • **compiler**: *[CompilerOpts](#class-compileropts)* -*Defined in [index.ts:641](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L641)* +*Defined in [index.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L641)* ___ @@ -2224,7 +2239,7 @@ ___ • **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* -*Defined in [index.ts:651](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L651)* +*Defined in [index.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L651)* ___ @@ -2232,7 +2247,7 @@ ___ • **sourceCodes**: *object* -*Defined in [index.ts:647](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L647)* +*Defined in [index.ts:647](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L647)* #### Type declaration: @@ -2244,7 +2259,7 @@ ___ • **sourceTreeHashHex**: *string* -*Defined in [index.ts:650](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L650)* +*Defined in [index.ts:650](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L650)* ___ @@ -2252,7 +2267,7 @@ ___ • **sources**: *object* -*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L642)* +*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L642)* #### Type declaration: @@ -2269,7 +2284,7 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)* +*Defined in [index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* ___ @@ -2277,7 +2292,7 @@ ___ • **name**: *string* -*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2285,7 +2300,7 @@ ___ • **type**: *string* -*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -2305,7 +2320,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2313,7 +2328,7 @@ ___ • **args**: *`A`* -*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* +*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* ___ @@ -2323,7 +2338,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -2333,7 +2348,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2343,7 +2358,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2351,7 +2366,7 @@ ___ • **event**: *string* -*Defined in [index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* +*Defined in [index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* ___ @@ -2361,7 +2376,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -2371,7 +2386,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -2381,7 +2396,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -2391,7 +2406,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -2410,7 +2425,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2420,7 +2435,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* +*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* ___ @@ -2430,7 +2445,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -2440,7 +2455,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2450,7 +2465,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2460,7 +2475,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* +*Defined in [index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* ___ @@ -2470,7 +2485,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -2478,7 +2493,7 @@ ___ • **removed**: *boolean* -*Defined in [index.ts:421](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L421)* +*Defined in [index.ts:421](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L421)* ___ @@ -2488,7 +2503,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -2498,7 +2513,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -2508,7 +2523,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -2521,7 +2536,7 @@ ___ • **author**? : *undefined | string* -*Defined in [index.ts:628](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L628)* +*Defined in [index.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L628)* ___ @@ -2529,7 +2544,7 @@ ___ • **methods**: *object* -*Defined in [index.ts:629](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L629)* +*Defined in [index.ts:629](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L629)* #### Type declaration: @@ -2541,7 +2556,7 @@ ___ • **title**? : *undefined | string* -*Defined in [index.ts:627](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L627)* +*Defined in [index.ts:627](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L627)*
@@ -2554,7 +2569,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)* +*Defined in [index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -2562,7 +2577,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)* +*Defined in [index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -2586,7 +2601,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)* +*Defined in [index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -2608,7 +2623,7 @@ Name | Type | • **anonymous**: *boolean* -*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L131)* +*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L131)* ___ @@ -2616,7 +2631,7 @@ ___ • **inputs**: *[EventParameter](#class-eventparameter)[]* -*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L130)* +*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L130)* ___ @@ -2624,7 +2639,7 @@ ___ • **name**: *string* -*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L129)* +*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L129)* ___ @@ -2632,7 +2647,7 @@ ___ • **type**: *string* -*Defined in [index.ts:128](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L128)* +*Defined in [index.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L128)*
@@ -2647,7 +2662,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[components](#optional-components)* -*Defined in [index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)* +*Defined in [index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* ___ @@ -2655,7 +2670,7 @@ ___ • **indexed**: *boolean* -*Defined in [index.ts:116](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L116)* +*Defined in [index.ts:116](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L116)* ___ @@ -2665,7 +2680,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2675,7 +2690,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -2688,7 +2703,7 @@ ___ • **object**: *string* -*Defined in [index.ts:622](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L622)* +*Defined in [index.ts:622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L622)* ___ @@ -2696,7 +2711,7 @@ ___ • **sourceMap**: *string* -*Defined in [index.ts:623](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L623)* +*Defined in [index.ts:623](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L623)*
@@ -2709,7 +2724,7 @@ ___ • **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [index.ts:617](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L617)* +*Defined in [index.ts:617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L617)* ___ @@ -2717,7 +2732,7 @@ ___ • **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [index.ts:618](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L618)* +*Defined in [index.ts:618](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L618)*
@@ -2730,7 +2745,7 @@ ___ • **payable**: *boolean* -*Defined in [index.ts:112](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L112)* +*Defined in [index.ts:112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L112)* ___ @@ -2738,7 +2753,7 @@ ___ • **type**: *string* -*Defined in [index.ts:111](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L111)* +*Defined in [index.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L111)*
@@ -2751,7 +2766,7 @@ ___ • **address**? : *undefined | string* -*Defined in [index.ts:409](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L409)* +*Defined in [index.ts:409](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L409)* ___ @@ -2759,7 +2774,7 @@ ___ • **blockHash**? : *undefined | string* -*Defined in [index.ts:408](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L408)* +*Defined in [index.ts:408](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L408)* ___ @@ -2767,7 +2782,7 @@ ___ • **fromBlock**? : *number | string* -*Defined in [index.ts:406](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L406)* +*Defined in [index.ts:406](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L406)* ___ @@ -2775,7 +2790,7 @@ ___ • **toBlock**? : *number | string* -*Defined in [index.ts:407](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L407)* +*Defined in [index.ts:407](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L407)* ___ @@ -2783,44 +2798,29 @@ ___ • **topics**? : *[LogTopic](#logtopic)[]* -*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L410)* +*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L410)*
-# Enumeration: AbiType +# Interface: GanacheProvider -## Enumeration members +## Methods -### Constructor +### sendAsync -• **Constructor**: = "constructor" +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:463](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L463)* +*Defined in [index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L14)* -___ +**Parameters:** -### Event +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | -• **Event**: = "event" - -*Defined in [index.ts:464](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L464)* - -___ - -### Fallback - -• **Fallback**: = "fallback" - -*Defined in [index.ts:465](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L465)* - -___ - -### Function - -• **Function**: = "function" - -*Defined in [index.ts:462](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L462)* +**Returns:** *void*
@@ -2833,7 +2833,7 @@ ___ • **name**: *"solc"* -*Defined in [index.ts:680](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L680)* +*Defined in [index.ts:680](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L680)* ___ @@ -2841,7 +2841,7 @@ ___ • **settings**: *[CompilerSettings](#class-compilersettings)* -*Defined in [index.ts:682](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L682)* +*Defined in [index.ts:682](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L682)* ___ @@ -2849,7 +2849,7 @@ ___ • **version**: *string* -*Defined in [index.ts:681](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L681)* +*Defined in [index.ts:681](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L681)*
@@ -2862,7 +2862,7 @@ ___ • **id**: *number* -*Defined in [index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* +*Defined in [index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* ___ @@ -2870,7 +2870,7 @@ ___ • **jsonrpc**: *string* -*Defined in [index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* +*Defined in [index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* ___ @@ -2878,7 +2878,7 @@ ___ • **method**: *string* -*Defined in [index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* +*Defined in [index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* ___ @@ -2886,7 +2886,7 @@ ___ • **params**: *any[]* -*Defined in [index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* +*Defined in [index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)*
@@ -2899,7 +2899,7 @@ ___ • **code**: *number* -*Defined in [index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* +*Defined in [index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* ___ @@ -2907,7 +2907,7 @@ ___ • **message**: *string* -*Defined in [index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* +*Defined in [index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)*
@@ -2920,7 +2920,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* +*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* ___ @@ -2928,7 +2928,7 @@ ___ • **id**: *number* -*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* +*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* ___ @@ -2936,7 +2936,7 @@ ___ • **jsonrpc**: *string* -*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* +*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* ___ @@ -2944,7 +2944,7 @@ ___ • **result**: *any* -*Defined in [index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* +*Defined in [index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
@@ -2957,7 +2957,7 @@ ___ • **address**: *string* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2965,7 +2965,7 @@ ___ • **blockHash**: *string | null* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -2973,7 +2973,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2981,7 +2981,7 @@ ___ • **data**: *string* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2989,7 +2989,7 @@ ___ • **logIndex**: *number | null* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -2997,7 +2997,7 @@ ___ • **topics**: *string[]* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3005,7 +3005,7 @@ ___ • **transactionHash**: *string* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -3013,7 +3013,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -3028,7 +3028,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3038,7 +3038,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3048,7 +3048,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3058,7 +3058,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3068,7 +3068,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -3076,7 +3076,7 @@ ___ • **removed**: *boolean* -*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L425)* ___ @@ -3086,7 +3086,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3096,7 +3096,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -3106,7 +3106,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -3125,7 +3125,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3135,7 +3135,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* +*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* ___ @@ -3145,7 +3145,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3155,7 +3155,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3165,7 +3165,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3175,7 +3175,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* +*Defined in [index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* ___ @@ -3185,7 +3185,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -3195,7 +3195,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3205,7 +3205,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -3215,7 +3215,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -3228,7 +3228,7 @@ ___ • **constant**: *boolean* -*Defined in [index.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L94)* +*Defined in [index.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L94)* ___ @@ -3236,7 +3236,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:92](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L92)* +*Defined in [index.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L92)* ___ @@ -3244,7 +3244,7 @@ ___ • **name**: *string* -*Defined in [index.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L91)* +*Defined in [index.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L91)* ___ @@ -3252,7 +3252,7 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L93)* +*Defined in [index.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L93)* ___ @@ -3260,7 +3260,7 @@ ___ • **payable**: *boolean* -*Defined in [index.ts:96](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L96)* +*Defined in [index.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L96)* ___ @@ -3268,7 +3268,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [index.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L95)* +*Defined in [index.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L95)* ___ @@ -3276,7 +3276,7 @@ ___ • **type**: *string* -*Defined in [index.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L90)* +*Defined in [index.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L90)*
@@ -3289,7 +3289,7 @@ ___ • **enabled**: *boolean* -*Defined in [index.ts:708](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L708)* +*Defined in [index.ts:708](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L708)* ___ @@ -3297,7 +3297,7 @@ ___ • **runs**? : *undefined | number* -*Defined in [index.ts:709](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L709)* +*Defined in [index.ts:709](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L709)*
@@ -3310,7 +3310,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L20)* +*Defined in [index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L20)* **Parameters:** @@ -3332,7 +3332,7 @@ Name | Type | • **address**: *string* -*Defined in [index.ts:491](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L491)* +*Defined in [index.ts:491](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L491)* ___ @@ -3340,7 +3340,7 @@ ___ • **blockHash**: *string | null* -*Defined in [index.ts:489](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L489)* +*Defined in [index.ts:489](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L489)* ___ @@ -3348,7 +3348,7 @@ ___ • **blockNumber**: *string | null* -*Defined in [index.ts:490](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L490)* +*Defined in [index.ts:490](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L490)* ___ @@ -3356,7 +3356,7 @@ ___ • **data**: *string* -*Defined in [index.ts:492](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L492)* +*Defined in [index.ts:492](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L492)* ___ @@ -3364,7 +3364,7 @@ ___ • **logIndex**: *string | null* -*Defined in [index.ts:486](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L486)* +*Defined in [index.ts:486](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L486)* ___ @@ -3372,7 +3372,7 @@ ___ • **topics**: *string[]* -*Defined in [index.ts:493](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L493)* +*Defined in [index.ts:493](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L493)* ___ @@ -3380,7 +3380,7 @@ ___ • **transactionHash**: *string* -*Defined in [index.ts:488](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L488)* +*Defined in [index.ts:488](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L488)* ___ @@ -3388,7 +3388,7 @@ ___ • **transactionIndex**: *string | null* -*Defined in [index.ts:487](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L487)* +*Defined in [index.ts:487](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L487)*
@@ -3401,7 +3401,7 @@ ___ • **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L122)* +*Defined in [index.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L122)* ___ @@ -3409,7 +3409,7 @@ ___ • **name**: *string* -*Defined in [index.ts:121](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L121)* +*Defined in [index.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L121)* ___ @@ -3417,7 +3417,7 @@ ___ • **type**: *"error"* -*Defined in [index.ts:120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L120)* +*Defined in [index.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L120)*
@@ -3430,7 +3430,7 @@ ___ • **component**: *"general" | "ewasm"* -*Defined in [index.ts:604](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L604)* +*Defined in [index.ts:604](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L604)* ___ @@ -3438,7 +3438,7 @@ ___ • **formattedMessage**? : *undefined | string* -*Defined in [index.ts:607](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L607)* +*Defined in [index.ts:607](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L607)* ___ @@ -3446,7 +3446,7 @@ ___ • **message**: *string* -*Defined in [index.ts:606](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L606)* +*Defined in [index.ts:606](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L606)* ___ @@ -3454,7 +3454,7 @@ ___ • **severity**: *[ErrorSeverity](#errorseverity)* -*Defined in [index.ts:605](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L605)* +*Defined in [index.ts:605](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L605)* ___ @@ -3462,7 +3462,7 @@ ___ • **sourceLocation**? : *[SourceLocation](#class-sourcelocation)* -*Defined in [index.ts:602](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L602)* +*Defined in [index.ts:602](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L602)* ___ @@ -3470,7 +3470,7 @@ ___ • **type**: *[ErrorType](#errortype)* -*Defined in [index.ts:603](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L603)* +*Defined in [index.ts:603](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L603)*
@@ -3483,7 +3483,7 @@ ___ • **id**: *number* -*Defined in [index.ts:713](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L713)* +*Defined in [index.ts:713](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L713)*
@@ -3496,7 +3496,7 @@ ___ • **end**: *number* -*Defined in [index.ts:613](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L613)* +*Defined in [index.ts:613](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L613)* ___ @@ -3504,7 +3504,7 @@ ___ • **file**: *string* -*Defined in [index.ts:611](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L611)* +*Defined in [index.ts:611](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L611)* ___ @@ -3512,7 +3512,7 @@ ___ • **start**: *number* -*Defined in [index.ts:612](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L612)* +*Defined in [index.ts:612](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L612)*
@@ -3525,7 +3525,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [index.ts:564](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L564)* +*Defined in [index.ts:564](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L564)* ___ @@ -3533,7 +3533,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [index.ts:566](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L566)* +*Defined in [index.ts:566](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L566)* ___ @@ -3541,7 +3541,7 @@ ___ • **evm**: *[EvmOutput](#class-evmoutput)* -*Defined in [index.ts:565](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L565)* +*Defined in [index.ts:565](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L565)*
@@ -3554,7 +3554,7 @@ ___ • **contracts**: *object* -*Defined in [index.ts:578](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L578)* +*Defined in [index.ts:578](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L578)* #### Type declaration: @@ -3568,7 +3568,7 @@ ___ • **errors**: *[SolcError](#class-solcerror)[]* -*Defined in [index.ts:570](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L570)* +*Defined in [index.ts:570](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L570)* ___ @@ -3576,7 +3576,7 @@ ___ • **sources**: *object* -*Defined in [index.ts:571](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L571)* +*Defined in [index.ts:571](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L571)* #### Type declaration: @@ -3593,7 +3593,7 @@ ___ • **depth**: *number* -*Defined in [index.ts:293](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L293)* +*Defined in [index.ts:293](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L293)* ___ @@ -3601,7 +3601,7 @@ ___ • **error**: *string* -*Defined in [index.ts:294](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L294)* +*Defined in [index.ts:294](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L294)* ___ @@ -3609,7 +3609,7 @@ ___ • **gas**: *number* -*Defined in [index.ts:295](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L295)* +*Defined in [index.ts:295](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L295)* ___ @@ -3617,7 +3617,7 @@ ___ • **gasCost**: *number* -*Defined in [index.ts:296](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L296)* +*Defined in [index.ts:296](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L296)* ___ @@ -3625,7 +3625,7 @@ ___ • **memory**: *string[]* -*Defined in [index.ts:297](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L297)* +*Defined in [index.ts:297](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L297)* ___ @@ -3633,7 +3633,7 @@ ___ • **op**: *[OpCode](#enumeration-opcode)* -*Defined in [index.ts:298](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L298)* +*Defined in [index.ts:298](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L298)* ___ @@ -3641,7 +3641,7 @@ ___ • **pc**: *number* -*Defined in [index.ts:299](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L299)* +*Defined in [index.ts:299](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L299)* ___ @@ -3649,7 +3649,7 @@ ___ • **stack**: *string[]* -*Defined in [index.ts:300](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L300)* +*Defined in [index.ts:300](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L300)* ___ @@ -3657,7 +3657,7 @@ ___ • **storage**: *object* -*Defined in [index.ts:301](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L301)* +*Defined in [index.ts:301](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L301)* #### Type declaration: @@ -3674,7 +3674,7 @@ ___ • **disableMemory**? : *undefined | false | true* -*Defined in [index.ts:518](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L518)* +*Defined in [index.ts:518](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L518)* ___ @@ -3682,7 +3682,7 @@ ___ • **disableStack**? : *undefined | false | true* -*Defined in [index.ts:519](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L519)* +*Defined in [index.ts:519](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L519)* ___ @@ -3690,7 +3690,7 @@ ___ • **disableStorage**? : *undefined | false | true* -*Defined in [index.ts:520](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L520)* +*Defined in [index.ts:520](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L520)* ___ @@ -3698,7 +3698,7 @@ ___ • **timeout**? : *undefined | string* -*Defined in [index.ts:522](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L522)* +*Defined in [index.ts:522](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L522)* ___ @@ -3706,7 +3706,7 @@ ___ • **tracer**? : *undefined | string* -*Defined in [index.ts:521](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L521)* +*Defined in [index.ts:521](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L521)*
@@ -3719,7 +3719,7 @@ ___ • **blockHash**: *string | null* -*Defined in [index.ts:377](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L377)* +*Defined in [index.ts:377](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L377)* ___ @@ -3727,7 +3727,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [index.ts:378](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L378)* +*Defined in [index.ts:378](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L378)* ___ @@ -3735,7 +3735,7 @@ ___ • **from**: *string* -*Defined in [index.ts:380](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L380)* +*Defined in [index.ts:380](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L380)* ___ @@ -3743,7 +3743,7 @@ ___ • **gas**: *number* -*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L384)* +*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L384)* ___ @@ -3751,7 +3751,7 @@ ___ • **gasPrice**: *`BigNumber`* -*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L383)* ___ @@ -3759,7 +3759,7 @@ ___ • **hash**: *string* -*Defined in [index.ts:375](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L375)* +*Defined in [index.ts:375](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L375)* ___ @@ -3767,7 +3767,7 @@ ___ • **input**: *string* -*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L385)* ___ @@ -3775,7 +3775,7 @@ ___ • **nonce**: *number* -*Defined in [index.ts:376](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L376)* +*Defined in [index.ts:376](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L376)* ___ @@ -3783,7 +3783,7 @@ ___ • **to**: *string | null* -*Defined in [index.ts:381](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L381)* +*Defined in [index.ts:381](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L381)* ___ @@ -3791,7 +3791,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [index.ts:379](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L379)* +*Defined in [index.ts:379](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L379)* ___ @@ -3799,7 +3799,7 @@ ___ • **value**: *`BigNumber`* -*Defined in [index.ts:382](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L382)* +*Defined in [index.ts:382](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L382)*
@@ -3812,7 +3812,7 @@ ___ • **blockHash**: *string* -*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L448)* +*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L448)* ___ @@ -3820,7 +3820,7 @@ ___ • **blockNumber**: *number* -*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L449)* +*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L449)* ___ @@ -3828,7 +3828,7 @@ ___ • **contractAddress**: *string | null* -*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L457)* +*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L457)* ___ @@ -3836,7 +3836,7 @@ ___ • **cumulativeGasUsed**: *number* -*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L455)* +*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L455)* ___ @@ -3844,7 +3844,7 @@ ___ • **from**: *string* -*Defined in [index.ts:452](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L452)* +*Defined in [index.ts:452](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L452)* ___ @@ -3852,7 +3852,7 @@ ___ • **gasUsed**: *number* -*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L456)* +*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L456)* ___ @@ -3860,7 +3860,7 @@ ___ • **logs**: *[LogEntry](#class-logentry)[]* -*Defined in [index.ts:458](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L458)* +*Defined in [index.ts:458](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L458)* ___ @@ -3868,7 +3868,7 @@ ___ • **status**: *[TransactionReceiptStatus](#transactionreceiptstatus)* -*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L454)* +*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L454)* ___ @@ -3876,7 +3876,7 @@ ___ • **to**: *string* -*Defined in [index.ts:453](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L453)* +*Defined in [index.ts:453](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L453)* ___ @@ -3884,7 +3884,7 @@ ___ • **transactionHash**: *string* -*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L450)* +*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L450)* ___ @@ -3892,7 +3892,7 @@ ___ • **transactionIndex**: *number* -*Defined in [index.ts:451](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L451)* +*Defined in [index.ts:451](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L451)*
@@ -3911,7 +3911,7 @@ otherwise we don't. *Inherited from [TransactionReceipt](#interface-transactionreceipt).[blockHash](#blockhash)* -*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L448)* +*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L448)* ___ @@ -3921,7 +3921,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[blockNumber](#blocknumber)* -*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L449)* +*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L449)* ___ @@ -3931,7 +3931,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[contractAddress](#contractaddress)* -*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L457)* +*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L457)* ___ @@ -3941,7 +3941,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[cumulativeGasUsed](#cumulativegasused)* -*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L455)* +*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L455)* ___ @@ -3951,7 +3951,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[from](#from)* -*Defined in [index.ts:452](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L452)* +*Defined in [index.ts:452](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L452)* ___ @@ -3961,7 +3961,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[gasUsed](#gasused)* -*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L456)* +*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L456)* ___ @@ -3971,7 +3971,7 @@ ___ *Overrides [TransactionReceipt](_index_.transactionreceipt.md).[logs](#logs)* -*Defined in [index.ts:514](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L514)* +*Defined in [index.ts:514](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L514)* ___ @@ -3981,7 +3981,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[status](#status)* -*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L454)* +*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L454)* ___ @@ -3991,7 +3991,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[to](#to)* -*Defined in [index.ts:453](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L453)* +*Defined in [index.ts:453](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L453)* ___ @@ -4001,7 +4001,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[transactionHash](#transactionhash)* -*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L450)* +*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L450)* ___ @@ -4011,7 +4011,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[transactionIndex](#transactionindex)* -*Defined in [index.ts:451](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L451)* +*Defined in [index.ts:451](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L451)*
@@ -4024,7 +4024,7 @@ ___ • **gas**: *number* -*Defined in [index.ts:305](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L305)* +*Defined in [index.ts:305](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L305)* ___ @@ -4032,7 +4032,7 @@ ___ • **returnValue**: *any* -*Defined in [index.ts:306](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L306)* +*Defined in [index.ts:306](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L306)* ___ @@ -4040,7 +4040,7 @@ ___ • **structLogs**: *[StructLog](#class-structlog)[]* -*Defined in [index.ts:307](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L307)* +*Defined in [index.ts:307](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L307)*
@@ -4055,7 +4055,7 @@ ___ *Overrides [DataItem](_index_.dataitem.md).[components](#optional-components)* -*Defined in [index.ts:141](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L141)* +*Defined in [index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L141)* ___ @@ -4065,7 +4065,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -4075,7 +4075,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -4090,7 +4090,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -4098,7 +4098,7 @@ ___ • **from**: *string* -*Defined in [index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* +*Defined in [index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -4108,7 +4108,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -4118,7 +4118,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -4128,7 +4128,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -4138,7 +4138,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -4148,7 +4148,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* +*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
@@ -4163,7 +4163,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -4173,7 +4173,7 @@ ___ *Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* +*Defined in [index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -4183,7 +4183,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -4193,7 +4193,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -4203,7 +4203,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -4213,7 +4213,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -4223,7 +4223,7 @@ ___ *Overrides [CallTxDataBase](_index_.calltxdatabase.md).[value](#optional-value)* -*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L442)* +*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L442)*
@@ -4240,7 +4240,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/44793a9cf/packages/ethereum-types/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -4256,7 +4256,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -4282,7 +4282,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/44793a9cf/packages/ethereum-types/src/index.ts#L54)* +*Defined in [index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -4308,7 +4308,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/44793a9cf/packages/ethereum-types/src/index.ts#L63)* +*Defined in [index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -4334,7 +4334,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L31)* +*Defined in [index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ @@ -4342,7 +4342,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L32)* +*Defined in [index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ @@ -4350,7 +4350,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L30)* +*Defined in [index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -4358,7 +4358,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [index.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L34)* +*Defined in [index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -4368,7 +4368,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:35](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L35)* +*Defined in [index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -4385,7 +4385,7 @@ ___ ▸ **stop**(): *void* -*Defined in [index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)* +*Defined in [index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -4400,7 +4400,7 @@ ___ Ƭ **AbiDefinition**: *[FunctionAbi](_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)* -*Defined in [index.ts:80](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L80)* +*Defined in [index.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L80)* ___ @@ -4408,7 +4408,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [index.ts:483](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L483)* +*Defined in [index.ts:483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L483)* ___ @@ -4416,7 +4416,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [index.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L84)* +*Defined in [index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L84)* ___ @@ -4424,7 +4424,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [index.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L78)* +*Defined in [index.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L78)* ___ @@ -4432,7 +4432,7 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [index.ts:468](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L468)* +*Defined in [index.ts:468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L468)* ___ @@ -4440,7 +4440,7 @@ ___ Ƭ **DecodedLogs**: *`Array>`* -*Defined in [index.ts:439](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L439)* +*Defined in [index.ts:439](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L439)* ___ @@ -4448,7 +4448,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)* +*Defined in [index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 +4459,7 @@ ___ Ƭ **ErrorSeverity**: *"error" | "warning"* -*Defined in [index.ts:599](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L599)* +*Defined in [index.ts:599](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L599)* ___ @@ -4467,7 +4467,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/44793a9cf/packages/ethereum-types/src/index.ts#L585)* +*Defined in [index.ts:585](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L585)* ___ @@ -4475,7 +4475,7 @@ ___ Ƭ **FunctionAbi**: *[MethodAbi](#interface-methodabi) | [ConstructorAbi](#interface-constructorabi) | [FallbackAbi](#interface-fallbackabi)* -*Defined in [index.ts:82](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L82)* +*Defined in [index.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L82)* ___ @@ -4483,7 +4483,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)* +*Defined in [index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -4502,7 +4502,7 @@ ___ Ƭ **LogTopic**: *null | string | string[]* -*Defined in [index.ts:413](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L413)* +*Defined in [index.ts:413](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L413)* ___ @@ -4510,7 +4510,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/44793a9cf/packages/ethereum-types/src/index.ts#L525)* +*Defined in [index.ts:525](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L525)* ___ @@ -4518,7 +4518,7 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [index.ts:561](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L561)* +*Defined in [index.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L561)* ___ @@ -4526,7 +4526,7 @@ ___ Ƭ **RawLog**: *[LogEntry](#interface-logentry)* -*Defined in [index.ts:475](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L475)* +*Defined in [index.ts:475](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L475)* ___ @@ -4534,7 +4534,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [index.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L85)* +*Defined in [index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L85)* ___ @@ -4542,7 +4542,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/44793a9cf/packages/ethereum-types/src/index.ts#L9)* +*Defined in [index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 +4553,7 @@ ___ Ƭ **TransactionReceiptStatus**: *null | string | `0` | `1`* -*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L445)* +*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L445)* ___ @@ -4561,7 +4561,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/44793a9cf/packages/ethereum-types/src/index.ts#L310)* +*Defined in [index.ts:310](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L310)* ___ @@ -4569,7 +4569,7 @@ ___ Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* -*Defined in [index.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L11)* +*Defined in [index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)*
diff --git a/packages/json-schemas/CHANGELOG.json b/packages/json-schemas/CHANGELOG.json index 202a80c668..9ae7381703 100644 --- a/packages/json-schemas/CHANGELOG.json +++ b/packages/json-schemas/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "4.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "4.1.0-beta.0", "changes": [ diff --git a/packages/json-schemas/CHANGELOG.md b/packages/json-schemas/CHANGELOG.md index 6f54b93b4e..9d107cd0ad 100644 --- a/packages/json-schemas/CHANGELOG.md +++ b/packages/json-schemas/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v4.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v4.1.0-beta.0 - _October 3, 2019_ * Add `eip712DomainSchema` schema (#1742) diff --git a/packages/json-schemas/docs/reference.mdx b/packages/json-schemas/docs/reference.mdx index 085bfa9dc0..077fd6dedc 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/44793a9cf/packages/json-schemas/src/schema_validator.ts#L15)* +*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/json-schemas/src/schema_validator.ts#L32)* +*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/json-schemas/src/schema_validator.ts#L57)* +*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/json-schemas/src/schema_validator.ts#L46)* +*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 3daee0445a..04a5829780 100644 --- a/packages/migrations/CHANGELOG.json +++ b/packages/migrations/CHANGELOG.json @@ -6,8 +6,7 @@ "note": "Update all contract deployments to pass the actual chain ID (rather than the network ID) via the newly modified @0x/utils/provider_utils", "pr": 2270 } - ], - "timestamp": 1573001598 + ] }, { "version": "4.4.0-beta.0", diff --git a/packages/migrations/CHANGELOG.md b/packages/migrations/CHANGELOG.md index 8ef4a19f94..e9cd247c72 100644 --- a/packages/migrations/CHANGELOG.md +++ b/packages/migrations/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v4.4.0-beta.1 - _November 6, 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) - ## v4.4.0-beta.0 - _October 3, 2019_ * Update Coordinator and Exchange deployments to pass `chainId` (#1742) diff --git a/packages/migrations/docs/reference.mdx b/packages/migrations/docs/reference.mdx index 97001e7d1b..be2b4248f5 100644 --- a/packages/migrations/docs/reference.mdx +++ b/packages/migrations/docs/reference.mdx @@ -1,25 +1,5 @@ -# 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/44793a9cf/packages/ethereum-types/src/index.ts#L14)* - -**Parameters:** - -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | - -**Returns:** *void* - -
- @@ -37,7 +17,7 @@ Name | Type | • **assetProxyOwner**: *string* -*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L10)* +*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L9)* ___ @@ -45,7 +25,7 @@ ___ • **coordinator**: *string* -*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L16)* +*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L14)* ___ @@ -53,7 +33,7 @@ ___ • **coordinatorRegistry**: *string* -*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L15)* +*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L13)* ___ @@ -61,7 +41,7 @@ ___ • **devUtils**: *string* -*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L20)* +*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L18)* ___ @@ -69,7 +49,7 @@ ___ • **dutchAuction**: *string* -*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L14)* +*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L12)* ___ @@ -77,15 +57,7 @@ ___ • **erc1155Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L19)* - -___ - -### erc20BridgeProxy - -• **erc20BridgeProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L24)* +*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L17)* ___ @@ -93,7 +65,7 @@ ___ • **erc20Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L4)* +*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L4)* ___ @@ -101,7 +73,7 @@ ___ • **erc721Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L5)* +*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L5)* ___ @@ -109,7 +81,7 @@ ___ • **etherToken**: *string* -*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L7)* +*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L7)* ___ @@ -117,15 +89,7 @@ ___ • **exchange**: *string* -*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L9)* - -___ - -### exchangeV2 - -• **exchangeV2**: *string* - -*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L8)* +*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L8)* ___ @@ -133,7 +97,7 @@ ___ • **forwarder**: *string* -*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L12)* +*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L10)* ___ @@ -141,7 +105,7 @@ ___ • **multiAssetProxy**: *string* -*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L17)* +*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L15)* ___ @@ -149,23 +113,7 @@ ___ • **orderValidator**: *string* -*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L13)* - -___ - -### staking - -• **staking**: *string* - -*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L22)* - -___ - -### stakingProxy - -• **stakingProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L23)* +*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L11)* ___ @@ -173,15 +121,7 @@ ___ • **staticCallProxy**: *string* -*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L18)* - -___ - -### zeroExGovernor - -• **zeroExGovernor**: *string* - -*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L11)* +*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L16)* ___ @@ -189,15 +129,7 @@ ___ • **zrxToken**: *string* -*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L6)* - -___ - -### zrxVault - -• **zrxVault**: *string* - -*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L21)* +*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L6)*
@@ -246,7 +178,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -254,7 +186,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -278,7 +210,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -303,8 +235,28 @@ 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/9fe6c196a/packages/ethereum-types/src/index.ts#L14)* + +**Parameters:** + +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | + +**Returns:** *void* + +
+ # Interface: JSONRPCRequestPayload @@ -316,7 +268,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* ___ @@ -324,7 +276,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* ___ @@ -332,7 +284,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* ___ @@ -340,7 +292,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)*
@@ -353,7 +305,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* ___ @@ -361,7 +313,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)*
@@ -374,7 +326,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* ___ @@ -382,7 +334,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* ___ @@ -390,7 +342,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* ___ @@ -398,7 +350,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
@@ -453,7 +405,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -461,7 +413,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -471,7 +423,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -481,7 +433,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -491,7 +443,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -501,7 +453,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -511,7 +463,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
@@ -526,7 +478,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -536,7 +488,7 @@ ___ *Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -546,7 +498,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -556,7 +508,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -566,7 +518,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -576,7 +528,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -586,7 +538,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/44793a9cf/packages/ethereum-types/src/index.ts#L442)* +*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L442)*
@@ -603,7 +555,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/44793a9cf/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -619,7 +571,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/44793a9cf/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -645,7 +597,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/44793a9cf/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -671,7 +623,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/44793a9cf/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -697,7 +649,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ @@ -705,7 +657,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ @@ -713,7 +665,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -721,7 +673,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -731,7 +683,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/44793a9cf/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -748,7 +700,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -757,63 +709,13 @@ ___ -## Functions - -### runMigrationsAsync - -▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise`* - -*Defined in [migrations/src/migration.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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. - -
- - - - ## Functions ### getContractAddressesForNetworkOrThrow ▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)* -*Defined in [contract-addresses/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/contract-addresses/src/index.ts#L164)* +*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L128)* Used to get addresses of contracts that have been deployed to either the Ethereum mainnet or a supported testnet. Throws if there are no known @@ -853,7 +755,7 @@ given networkId. Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -870,7 +772,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -899,7 +801,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/44793a9cf/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -914,7 +816,57 @@ ___ Ƭ **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/44793a9cf/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)* + +
+ + + + +## Functions + +### runMigrationsAsync + +▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise`* + +*Defined in [migrations/src/migration.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/migrations/src/migration.ts#L48)* + +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:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/migrations/src/migration.ts#L335)* + +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.
diff --git a/packages/order-utils/CHANGELOG.json b/packages/order-utils/CHANGELOG.json index a81eb6c691..9aaff69250 100644 --- a/packages/order-utils/CHANGELOG.json +++ b/packages/order-utils/CHANGELOG.json @@ -6,8 +6,7 @@ "note": "Remove `TransferFailedError` from `ForwarderRevertErrors`.", "pr": 2309 } - ], - "timestamp": 1573001598 + ] }, { "version": "8.5.0-beta.0", diff --git a/packages/order-utils/CHANGELOG.md b/packages/order-utils/CHANGELOG.md index 56051a2b90..2f217d5671 100644 --- a/packages/order-utils/CHANGELOG.md +++ b/packages/order-utils/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v8.5.0-beta.1 - _November 6, 2019_ - - * Remove `TransferFailedError` from `ForwarderRevertErrors`. (#2309) - ## v8.5.0-beta.0 - _October 3, 2019_ * Add `chainId` `OrderValidationUtils`, `OrderFactory` (#1742) @@ -38,8 +34,6 @@ CHANGELOG * Remove `validateOrderFillableOrThrowAsync`, `simpleValidateOrderFillableOrThrowAsync`, `validateMakerTransferThrowIfInvalidAsync` (#2181) * Add `PreviousEpochNotFinalizedError` to `StakingRevertErrors`. (#2155) * Add `InvalidMinimumPoolStake` to `StakingRevertErrors.InvalidParamValueErrorCode`. (#2155) - * Renamed `OnlyCallableByPoolOperatorOrMakerError` to `OnlyCallableByPoolOperatorError`. (#2250) - * Removed protocol fee != 0 error. (#2278) ## v8.4.0 - _September 17, 2019_ diff --git a/packages/order-utils/docs/reference.mdx b/packages/order-utils/docs/reference.mdx index dbb242a80c..ce24c7ebd6 100644 --- a/packages/order-utils/docs/reference.mdx +++ b/packages/order-utils/docs/reference.mdx @@ -1,4 +1,53 @@ +# 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/9fe6c196a/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/9fe6c196a/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 @@ -14,7 +63,7 @@ ▸ **deleteAll**(): *void* -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)* +*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)* **Returns:** *void* @@ -24,7 +73,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)* +*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)* **Parameters:** @@ -41,7 +90,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)* +*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)* **Parameters:** @@ -58,7 +107,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)* +*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)* **Parameters:** @@ -75,7 +124,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)* +*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)* **Parameters:** @@ -92,7 +141,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)* +*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)* **Parameters:** @@ -110,7 +159,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)* +*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)* **Parameters:** @@ -137,7 +186,7 @@ and whether it's been cancelled. ▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)* +*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)* Get the amount of the order's takerToken amount already filled @@ -157,7 +206,7 @@ ___ ▸ **isOrderCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)* +*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)* Whether an order is cancelled @@ -187,7 +236,7 @@ Whether or not the order is cancelled ▸ **deleteAll**(): *void* -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)* +*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)* **Returns:** *void* @@ -197,7 +246,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)* +*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)* **Parameters:** @@ -213,7 +262,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)* +*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)* **Parameters:** @@ -229,7 +278,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)* +*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)* **Parameters:** @@ -245,7 +294,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)* +*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)* **Parameters:** @@ -261,7 +310,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)* +*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)* **Parameters:** @@ -278,7 +327,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)* +*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)* **Parameters:** @@ -320,14 +369,6 @@ Name | Type | - - - - - - - - @@ -349,7 +390,7 @@ An exchange transfer simulator which simulates asset transfers exactly how the \+ **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/44793a9cf/packages/order-utils/src/exchange_transfer_simulator.ts#L50)* +*Defined in [order-utils/src/exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/exchange_transfer_simulator.ts#L50)* Instantiate a ExchangeTransferSimulator @@ -369,7 +410,7 @@ an instance of ExchangeTransferSimulator ▸ **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/44793a9cf/packages/order-utils/src/exchange_transfer_simulator.ts#L70)* +*Defined in [order-utils/src/exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/exchange_transfer_simulator.ts#L70)* Simulates transferFrom call performed by a proxy @@ -409,6 +450,8 @@ Name | Type | Description | + + @@ -421,7 +464,7 @@ Name | Type | Description | \+ **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:98](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_state_utils.ts#L98)* +*Defined in [order-utils/src/order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_state_utils.ts#L98)* Instantiate OrderStateUtils @@ -442,7 +485,7 @@ Instance of OrderStateUtils ▸ **getMaxFillableTakerAssetAmountAsync**(`signedOrder`: `SignedOrder`, `takerAddress`: string): *`Promise`* -*Defined in [order-utils/src/order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_state_utils.ts#L192)* +*Defined in [order-utils/src/order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_state_utils.ts#L192)* Get the max amount of the supplied order's takerAmount that could still be filled @@ -463,7 +506,7 @@ ___ ▸ **getOpenOrderRelevantStateAsync**(`signedOrder`: `SignedOrder`): *`Promise`* -*Defined in [order-utils/src/order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_state_utils.ts#L162)* +*Defined in [order-utils/src/order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_state_utils.ts#L162)* Get state relevant to an order (i.e makerBalance, makerAllowance, filledTakerAssetAmount, etc... @@ -483,7 +526,7 @@ ___ ▸ **getOpenOrderStateAsync**(`signedOrder`: `SignedOrder`, `transactionHash?`: undefined | string): *`Promise`* -*Defined in [order-utils/src/order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_state_utils.ts#L122)* +*Defined in [order-utils/src/order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_state_utils.ts#L122)* Get the orderState for an "open" order (i.e where takerAddress=NULL_ADDRESS) This method will only check the maker's balance/allowance to calculate the @@ -514,7 +557,7 @@ A utility class for validating orders \+ **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/44793a9cf/packages/order-utils/src/order_validation_utils.ts#L113)* +*Defined in [order-utils/src/order_validation_utils.ts:113](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_validation_utils.ts#L113)* Instantiate OrderValidationUtils @@ -535,7 +578,7 @@ An instance of OrderValidationUtils ▸ **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/44793a9cf/packages/order-utils/src/order_validation_utils.ts#L135)* +*Defined in [order-utils/src/order_validation_utils.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_validation_utils.ts#L135)* Validate a call to FillOrder and throw if it wouldn't succeed @@ -556,7 +599,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/order_validation_utils.ts#L27)* +*Defined in [order-utils/src/order_validation_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_validation_utils.ts#L27)* A TypeScript implementation mirroring the implementation of isRoundingError in the Exchange smart contract @@ -577,7 +620,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/order_validation_utils.ts#L53)* +*Defined in [order-utils/src/order_validation_utils.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -645,7 +688,7 @@ Copy on read store for balances/proxyAllowances of tokens/accounts \+ **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:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L23)* +*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L23)* Instantiates a BalanceAndProxyAllowanceLazyStore @@ -665,7 +708,7 @@ Instance of BalanceAndProxyAllowanceLazyStore ▸ **deleteAll**(): *void* -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L136)* +*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L136)* Delete all balances & allowances @@ -677,7 +720,7 @@ ___ ▸ **deleteAllERC721ProxyAllowance**(`tokenAddress`: string, `userAddress`: string): *void* -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:119](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L119)* +*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:119](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L119)* Clear all ERC721 0x proxy allowances a user has on all items of a specific ERC721 contract @@ -696,7 +739,7 @@ ___ ▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void* -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L63)* +*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L63)* Clear the balance of an asset for a user @@ -715,7 +758,7 @@ ___ ▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void* -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:106](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L106)* +*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:106](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L106)* Clear the 0x asset proxy allowance @@ -734,7 +777,7 @@ ___ ▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:39](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L39)* +*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L39)* Get a users balance of an asset @@ -753,7 +796,7 @@ ___ ▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:76](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L76)* +*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:76](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L76)* Get the 0x asset proxy allowance @@ -772,7 +815,7 @@ ___ ▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void* -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L52)* +*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L52)* Set the balance of an asset for a user @@ -792,7 +835,7 @@ ___ ▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void* -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L95)* +*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L95)* Set the 0x asset proxy allowance @@ -824,7 +867,7 @@ Copy on read store for balances/proxyAllowances of tokens/accounts \+ **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/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)* Instantiate a OrderFilledCancelledLazyStore @@ -844,7 +887,7 @@ An instance of OrderFilledCancelledLazyStore ▸ **deleteAll**(): *void* -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)* Clear all filled/cancelled state @@ -856,7 +899,7 @@ ___ ▸ **deleteAllFilled**(): *void* -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)* Clear all filled state @@ -868,7 +911,7 @@ ___ ▸ **deleteAllIsCancelled**(): *void* -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)* Clear all cancelled state @@ -880,7 +923,7 @@ ___ ▸ **deleteFilledTakerAmount**(`orderHash`: string): *void* -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)* Clear the filledTakerAssetAmount of an order @@ -898,7 +941,7 @@ ___ ▸ **deleteIsCancelled**(`orderHash`: string): *void* -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)* Clear whether the order has been cancelled if already set @@ -916,7 +959,7 @@ ___ ▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)* Get the filledTakerAssetAmount of an order @@ -936,7 +979,7 @@ ___ ▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)* Check if an order has been cancelled @@ -956,7 +999,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)* Set the filledTakerAssetAmount of an order @@ -975,7 +1018,7 @@ ___ ▸ **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/44793a9cf/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)* +*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:77](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)* Set whether an order has been cancelled or not @@ -1033,7 +1076,7 @@ Name | Type | Description | • **Maker**: = "maker" -*Defined in [order-utils/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L9)* +*Defined in [order-utils/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L9)* ___ @@ -1041,7 +1084,7 @@ ___ • **Taker**: = "taker" -*Defined in [order-utils/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L10)* +*Defined in [order-utils/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L10)*
@@ -1054,7 +1097,7 @@ ___ • **Fee**: = "fee" -*Defined in [order-utils/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L15)* +*Defined in [order-utils/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L15)* ___ @@ -1062,7 +1105,7 @@ ___ • **Trade**: = "trade" -*Defined in [order-utils/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L14)* +*Defined in [order-utils/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L14)*
@@ -1075,7 +1118,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/44793a9cf/packages/order-utils/src/types.ts#L5)* +*Defined in [order-utils/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L5)* ___ @@ -1083,7 +1126,7 @@ ___ • **InvalidSignature**: = "INVALID_SIGNATURE" -*Defined in [order-utils/src/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L4)* +*Defined in [order-utils/src/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L4)*
@@ -1096,7 +1139,7 @@ ___ • **ERC1155**: = "0xa7cb5fb7" -*Defined in [types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L166)* +*Defined in [types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L166)* ___ @@ -1104,7 +1147,7 @@ ___ • **ERC20**: = "0xf47261b0" -*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L163)* +*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L163)* ___ @@ -1112,7 +1155,7 @@ ___ • **ERC20Bridge**: = "0xdc1600f3" -*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L168)* +*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L168)* ___ @@ -1120,7 +1163,7 @@ ___ • **ERC721**: = "0x02571792" -*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L164)* +*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L164)* ___ @@ -1128,7 +1171,7 @@ ___ • **MultiAsset**: = "0x94cfcdd7" -*Defined in [types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L165)* +*Defined in [types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L165)* ___ @@ -1136,7 +1179,7 @@ ___ • **StaticCall**: = "0xc339d10a" -*Defined in [types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L167)* +*Defined in [types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L167)*
@@ -1151,7 +1194,7 @@ Errors originating from the 0x exchange contract • **BatchOrdersMustHaveAtLeastOneItem**: = "BATCH_ORDERS_MUST_HAVE_AT_LEAST_ONE_ITEM" -*Defined in [types/src/index.ts:98](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L98)* +*Defined in [types/src/index.ts:98](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L98)* ___ @@ -1159,7 +1202,7 @@ ___ • **BatchOrdersMustHaveSameExchangeAddress**: = "BATCH_ORDERS_MUST_HAVE_SAME_EXCHANGE_ADDRESS" -*Defined in [types/src/index.ts:97](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L97)* +*Defined in [types/src/index.ts:97](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L97)* ___ @@ -1167,7 +1210,7 @@ ___ • **FillBalanceAllowanceError**: = "FILL_BALANCE_ALLOWANCE_ERROR" -*Defined in [types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L84)* +*Defined in [types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L84)* ___ @@ -1175,7 +1218,7 @@ ___ • **InsufficientMakerAllowance**: = "INSUFFICIENT_MAKER_ALLOWANCE" -*Defined in [types/src/index.ts:88](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L88)* +*Defined in [types/src/index.ts:88](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L88)* ___ @@ -1183,7 +1226,7 @@ ___ • **InsufficientMakerBalance**: = "INSUFFICIENT_MAKER_BALANCE" -*Defined in [types/src/index.ts:87](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L87)* +*Defined in [types/src/index.ts:87](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L87)* ___ @@ -1191,7 +1234,7 @@ ___ • **InsufficientMakerFeeAllowance**: = "INSUFFICIENT_MAKER_FEE_ALLOWANCE" -*Defined in [types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L92)* +*Defined in [types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L92)* ___ @@ -1199,7 +1242,7 @@ ___ • **InsufficientMakerFeeBalance**: = "INSUFFICIENT_MAKER_FEE_BALANCE" -*Defined in [types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L91)* +*Defined in [types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L91)* ___ @@ -1207,7 +1250,7 @@ ___ • **InsufficientRemainingFillAmount**: = "INSUFFICIENT_REMAINING_FILL_AMOUNT" -*Defined in [types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L95)* +*Defined in [types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L95)* ___ @@ -1215,7 +1258,7 @@ ___ • **InsufficientTakerAllowance**: = "INSUFFICIENT_TAKER_ALLOWANCE" -*Defined in [types/src/index.ts:86](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L86)* +*Defined in [types/src/index.ts:86](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L86)* ___ @@ -1223,7 +1266,7 @@ ___ • **InsufficientTakerBalance**: = "INSUFFICIENT_TAKER_BALANCE" -*Defined in [types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L85)* +*Defined in [types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L85)* ___ @@ -1231,7 +1274,7 @@ ___ • **InsufficientTakerFeeAllowance**: = "INSUFFICIENT_TAKER_FEE_ALLOWANCE" -*Defined in [types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L90)* +*Defined in [types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L90)* ___ @@ -1239,7 +1282,7 @@ ___ • **InsufficientTakerFeeBalance**: = "INSUFFICIENT_TAKER_FEE_BALANCE" -*Defined in [types/src/index.ts:89](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L89)* +*Defined in [types/src/index.ts:89](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L89)* ___ @@ -1247,7 +1290,7 @@ ___ • **MultipleMakersInSingleCancelBatchDisallowed**: = "MULTIPLE_MAKERS_IN_SINGLE_CANCEL_BATCH_DISALLOWED" -*Defined in [types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L94)* +*Defined in [types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L94)* ___ @@ -1255,7 +1298,7 @@ ___ • **MultipleTakerTokensInFillUpToDisallowed**: = "MULTIPLE_TAKER_TOKENS_IN_FILL_UP_TO_DISALLOWED" -*Defined in [types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L96)* +*Defined in [types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L96)* ___ @@ -1263,7 +1306,7 @@ ___ • **OrderCancelExpired**: = "ORDER_CANCEL_EXPIRED" -*Defined in [types/src/index.ts:79](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L79)* +*Defined in [types/src/index.ts:79](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L79)* ___ @@ -1271,7 +1314,7 @@ ___ • **OrderCancelled**: = "ORDER_CANCELLED" -*Defined in [types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L80)* +*Defined in [types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L80)* ___ @@ -1279,7 +1322,7 @@ ___ • **OrderFillAmountZero**: = "ORDER_FILL_AMOUNT_ZERO" -*Defined in [types/src/index.ts:81](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L81)* +*Defined in [types/src/index.ts:81](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L81)* ___ @@ -1287,7 +1330,7 @@ ___ • **OrderFillExpired**: = "ORDER_FILL_EXPIRED" -*Defined in [types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L78)* +*Defined in [types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L78)* ___ @@ -1295,7 +1338,7 @@ ___ • **OrderFillRoundingError**: = "ORDER_FILL_ROUNDING_ERROR" -*Defined in [types/src/index.ts:83](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L83)* +*Defined in [types/src/index.ts:83](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L83)* ___ @@ -1303,7 +1346,7 @@ ___ • **OrderRemainingFillAmountZero**: = "ORDER_REMAINING_FILL_AMOUNT_ZERO" -*Defined in [types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L82)* +*Defined in [types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L82)* ___ @@ -1311,7 +1354,7 @@ ___ • **TransactionSenderIsNotFillOrderTaker**: = "TRANSACTION_SENDER_IS_NOT_FILL_ORDER_TAKER" -*Defined in [types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L93)* +*Defined in [types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L93)*
@@ -1334,7 +1377,7 @@ ___ • **EIP1271Wallet**: -*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L158)* +*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L158)* ___ @@ -1342,7 +1385,7 @@ ___ • **EIP712**: -*Defined in [types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L153)* +*Defined in [types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L153)* ___ @@ -1350,7 +1393,7 @@ ___ • **EthSign**: -*Defined in [types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L154)* +*Defined in [types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L154)* ___ @@ -1358,7 +1401,7 @@ ___ • **Illegal**: -*Defined in [types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L151)* +*Defined in [types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L151)* ___ @@ -1366,7 +1409,7 @@ ___ • **Invalid**: -*Defined in [types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L152)* +*Defined in [types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L152)* ___ @@ -1374,7 +1417,7 @@ ___ • **NSignatureTypes**: -*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L159)* +*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L159)* ___ @@ -1382,7 +1425,7 @@ ___ • **PreSigned**: -*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L157)* +*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L157)* ___ @@ -1390,7 +1433,7 @@ ___ • **Validator**: -*Defined in [types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L156)* +*Defined in [types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L156)* ___ @@ -1398,7 +1441,7 @@ ___ • **Wallet**: -*Defined in [types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L155)* +*Defined in [types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L155)*
@@ -1413,57 +1456,6 @@ ___ -## 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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/types/src/index.ts#L204)* - -
- - - - @@ -1506,7 +1498,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -1514,7 +1506,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -1538,7 +1530,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -1572,7 +1564,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/44793a9cf/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -1596,7 +1588,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* ___ @@ -1604,7 +1596,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* ___ @@ -1612,7 +1604,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* ___ @@ -1620,7 +1612,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)*
@@ -1633,7 +1625,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* ___ @@ -1641,7 +1633,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)*
@@ -1654,7 +1646,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* ___ @@ -1662,7 +1654,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* ___ @@ -1670,7 +1662,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* ___ @@ -1678,7 +1670,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
@@ -1702,56 +1694,7 @@ ___ -# 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/44793a9cf/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/44793a9cf/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 - -
@@ -1788,7 +1731,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/44793a9cf/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -1804,7 +1747,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/44793a9cf/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -1830,7 +1773,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/44793a9cf/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -1856,7 +1799,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/44793a9cf/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -1882,7 +1825,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ @@ -1890,7 +1833,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ @@ -1898,7 +1841,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -1906,7 +1849,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -1916,7 +1859,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/44793a9cf/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -1933,7 +1876,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -1954,7 +1897,7 @@ ___ • **feeOrdersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L78)* +*Defined in [order-utils/src/types.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L78)* ___ @@ -1962,7 +1905,7 @@ ___ • **remainingFeeAmount**: *`BigNumber`* -*Defined in [order-utils/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L79)* +*Defined in [order-utils/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L79)* ___ @@ -1970,7 +1913,7 @@ ___ • **resultFeeOrders**: *`T`[]* -*Defined in [order-utils/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L77)* +*Defined in [order-utils/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L77)*
@@ -1992,7 +1935,7 @@ Defaults to 0 • **remainingFillableFeeAmounts**? : *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L72)* +*Defined in [order-utils/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L72)* ___ @@ -2000,7 +1943,7 @@ ___ • **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:71](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L71)* +*Defined in [order-utils/src/types.ts:71](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L71)* ___ @@ -2008,7 +1951,7 @@ ___ • **slippageBufferAmount**? : *`BigNumber`* -*Defined in [order-utils/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L73)* +*Defined in [order-utils/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L73)*
@@ -2027,7 +1970,7 @@ Defaults to 0 • **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L44)* +*Defined in [order-utils/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L44)* ___ @@ -2035,7 +1978,7 @@ ___ • **slippageBufferAmount**? : *`BigNumber`* -*Defined in [order-utils/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L45)* +*Defined in [order-utils/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L45)*
@@ -2054,7 +1997,7 @@ Defaults to 0 • **remainingFillableTakerAssetAmounts**? : *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L56)* +*Defined in [order-utils/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L56)* ___ @@ -2062,7 +2005,7 @@ ___ • **slippageBufferAmount**? : *`BigNumber`* -*Defined in [order-utils/src/types.ts:57](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L57)* +*Defined in [order-utils/src/types.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L57)*
@@ -2079,7 +2022,7 @@ ___ • **ordersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L84)* +*Defined in [order-utils/src/types.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L84)* ___ @@ -2087,7 +2030,7 @@ ___ • **remainingFillAmount**: *`BigNumber`* -*Defined in [order-utils/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L85)* +*Defined in [order-utils/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L85)* ___ @@ -2095,7 +2038,7 @@ ___ • **resultOrders**: *`T`[]* -*Defined in [order-utils/src/types.ts:83](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L83)* +*Defined in [order-utils/src/types.ts:83](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L83)*
@@ -2112,7 +2055,7 @@ ___ • **ordersRemainingFillableTakerAssetAmounts**: *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L90)* +*Defined in [order-utils/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L90)* ___ @@ -2120,7 +2063,7 @@ ___ • **remainingFillAmount**: *`BigNumber`* -*Defined in [order-utils/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L91)* +*Defined in [order-utils/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L91)* ___ @@ -2128,7 +2071,7 @@ ___ • **resultOrders**: *`T`[]* -*Defined in [order-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/types.ts#L89)* +*Defined in [order-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/types.ts#L89)*
@@ -2155,8 +2098,6 @@ ___ - - @@ -2169,7 +2110,7 @@ ___ • **assetData**: *[AssetData](#assetdata)* -*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L219)* +*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L219)* ___ @@ -2177,7 +2118,7 @@ ___ • **beginAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L221)* +*Defined in [types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L221)* ___ @@ -2185,7 +2126,7 @@ ___ • **beginTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L220)* +*Defined in [types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L220)*
@@ -2202,7 +2143,7 @@ Elliptic Curve signature • **r**: *string* -*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L62)* +*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L62)* ___ @@ -2210,7 +2151,7 @@ ___ • **s**: *string* -*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L63)* +*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L63)* ___ @@ -2218,7 +2159,7 @@ ___ • **v**: *number* -*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L61)* +*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L61)*
@@ -2231,7 +2172,7 @@ ___ • **chainId**: *number* -*Defined in [types/src/index.ts:793](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L793)* +*Defined in [types/src/index.ts:802](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L802)* ___ @@ -2239,7 +2180,7 @@ ___ • **name**? : *undefined | string* -*Defined in [types/src/index.ts:791](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L791)* +*Defined in [types/src/index.ts:800](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L800)* ___ @@ -2247,7 +2188,7 @@ ___ • **verifyingContract**: *string* -*Defined in [types/src/index.ts:794](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L794)* +*Defined in [types/src/index.ts:803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L803)* ___ @@ -2255,7 +2196,7 @@ ___ • **version**? : *undefined | string* -*Defined in [types/src/index.ts:792](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L792)* +*Defined in [types/src/index.ts:801](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L801)*
@@ -2273,7 +2214,7 @@ ___ • **name**: *string* -*Defined in [types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L732)* +*Defined in [types/src/index.ts:720](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L720)* ___ @@ -2281,7 +2222,7 @@ ___ • **type**: *string* -*Defined in [types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L733)* +*Defined in [types/src/index.ts:721](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L721)*
@@ -2294,7 +2235,7 @@ ___ • **domain**: *[EIP712Object](#class-eip712object)* -*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L748)* +*Defined in [types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L736)* ___ @@ -2302,7 +2243,7 @@ ___ • **message**: *[EIP712Object](#class-eip712object)* -*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L749)* +*Defined in [types/src/index.ts:737](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L737)* ___ @@ -2310,7 +2251,7 @@ ___ • **primaryType**: *string* -*Defined in [types/src/index.ts:750](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L750)* +*Defined in [types/src/index.ts:738](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L738)* ___ @@ -2318,7 +2259,7 @@ ___ • **types**: *[EIP712Types](#class-eip712types)* -*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L747)* +*Defined in [types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L735)*
@@ -2336,7 +2277,7 @@ ___ • **name**: *string* -*Defined in [types/src/index.ts:686](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L686)* +*Defined in [types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L674)* ___ @@ -2344,7 +2285,7 @@ ___ • **typeDocType**: *[TypeDocTypes](#enumeration-typedoctypes)* -*Defined in [types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L687)* +*Defined in [types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L675)*
@@ -2357,7 +2298,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L183)* +*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L183)* ___ @@ -2365,7 +2306,7 @@ ___ • **callbackData**: *string* -*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L187)* +*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L187)* ___ @@ -2373,7 +2314,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L184)* +*Defined in [types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L184)* ___ @@ -2381,7 +2322,7 @@ ___ • **tokenIds**: *`BigNumber`[]* -*Defined in [types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L185)* +*Defined in [types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L185)* ___ @@ -2389,7 +2330,7 @@ ___ • **tokenValues**: *`BigNumber`[]* -*Defined in [types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L186)* +*Defined in [types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L186)*
@@ -2404,7 +2345,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L172)* +*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L172)* ___ @@ -2412,7 +2353,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L173)* +*Defined in [types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L173)*
@@ -2425,7 +2366,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L177)* +*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L177)* ___ @@ -2433,7 +2374,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L178)* +*Defined in [types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L178)* ___ @@ -2441,7 +2382,7 @@ ___ • **tokenId**: *`BigNumber`* -*Defined in [types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L179)* +*Defined in [types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L179)*
@@ -2470,7 +2411,7 @@ ___ • **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L208)* +*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L208)* ___ @@ -2478,7 +2419,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L207)* +*Defined in [types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L207)* ___ @@ -2486,7 +2427,7 @@ ___ • **nestedAssetData**: *string[]* -*Defined in [types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L209)* +*Defined in [types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L209)*
@@ -2499,7 +2440,7 @@ ___ • **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L214)* +*Defined in [types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L214)* ___ @@ -2507,7 +2448,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L213)* +*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L213)* ___ @@ -2515,7 +2456,7 @@ ___ • **nestedAssetData**: *[SingleAssetData](#singleassetdata)[]* -*Defined in [types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L215)* +*Defined in [types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L215)*
@@ -2539,7 +2480,7 @@ ___ • **chainId**: *number* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* ___ @@ -2547,7 +2488,7 @@ ___ • **exchangeAddress**: *string* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -2555,7 +2496,7 @@ ___ • **expirationTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -2563,7 +2504,7 @@ ___ • **feeRecipientAddress**: *string* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -2571,7 +2512,7 @@ ___ • **makerAddress**: *string* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -2579,7 +2520,7 @@ ___ • **makerAssetAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -2587,7 +2528,7 @@ ___ • **makerAssetData**: *string* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -2595,7 +2536,7 @@ ___ • **makerFee**: *`BigNumber`* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* ___ @@ -2603,7 +2544,7 @@ ___ • **makerFeeAssetData**: *string* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -2611,7 +2552,7 @@ ___ • **salt**: *`BigNumber`* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -2619,7 +2560,7 @@ ___ • **senderAddress**: *string* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -2627,7 +2568,7 @@ ___ • **takerAddress**: *string* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -2635,7 +2576,7 @@ ___ • **takerAssetAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -2643,7 +2584,7 @@ ___ • **takerAssetData**: *string* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -2651,7 +2592,7 @@ ___ • **takerFee**: *`BigNumber`* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* ___ @@ -2659,7 +2600,7 @@ ___ • **takerFeeAssetData**: *string* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -2682,7 +2623,7 @@ ___ • **filledTakerAssetAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L122)* +*Defined in [types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L122)* ___ @@ -2690,7 +2631,7 @@ ___ • **makerBalance**: *`BigNumber`* -*Defined in [types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L116)* +*Defined in [types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L116)* ___ @@ -2698,7 +2639,7 @@ ___ • **makerFeeBalance**: *`BigNumber`* -*Defined in [types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L120)* +*Defined in [types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L120)* ___ @@ -2706,7 +2647,7 @@ ___ • **makerFeeProxyAllowance**: *`BigNumber`* -*Defined in [types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L121)* +*Defined in [types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L121)* ___ @@ -2714,7 +2655,7 @@ ___ • **makerIndividualBalances**: *[ObjectMap](#class-objectmap)‹*`BigNumber`*›* -*Defined in [types/src/index.ts:117](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L117)* +*Defined in [types/src/index.ts:117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L117)* ___ @@ -2722,7 +2663,7 @@ ___ • **makerIndividualProxyAllowances**: *[ObjectMap](#class-objectmap)‹*`BigNumber`*›* -*Defined in [types/src/index.ts:119](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L119)* +*Defined in [types/src/index.ts:119](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L119)* ___ @@ -2730,7 +2671,7 @@ ___ • **makerProxyAllowance**: *`BigNumber`* -*Defined in [types/src/index.ts:118](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L118)* +*Defined in [types/src/index.ts:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L118)* ___ @@ -2738,7 +2679,7 @@ ___ • **remainingFillableMakerAssetAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:123](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L123)* +*Defined in [types/src/index.ts:123](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L123)* ___ @@ -2746,7 +2687,7 @@ ___ • **remainingFillableTakerAssetAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:124](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L124)* +*Defined in [types/src/index.ts:124](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L124)*
@@ -2763,7 +2704,7 @@ ___ • **error**: *[ExchangeContractErrs](#enumeration-exchangecontracterrs)* -*Defined in [types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L137)* +*Defined in [types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L137)* ___ @@ -2771,7 +2712,7 @@ ___ • **isValid**: *false* -*Defined in [types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L135)* +*Defined in [types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L135)* ___ @@ -2779,7 +2720,7 @@ ___ • **orderHash**: *string* -*Defined in [types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L136)* +*Defined in [types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L136)* ___ @@ -2787,7 +2728,7 @@ ___ • **transactionHash**? : *undefined | string* -*Defined in [types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L138)* +*Defined in [types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L138)*
@@ -2800,7 +2741,7 @@ ___ • **isValid**: *true* -*Defined in [types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L128)* +*Defined in [types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L128)* ___ @@ -2808,7 +2749,7 @@ ___ • **orderHash**: *string* -*Defined in [types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L129)* +*Defined in [types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L129)* ___ @@ -2816,7 +2757,7 @@ ___ • **orderRelevantState**: *[OrderRelevantState](#class-orderrelevantstate)* -*Defined in [types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L130)* +*Defined in [types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L130)* ___ @@ -2824,7 +2765,7 @@ ___ • **transactionHash**? : *undefined | string* -*Defined in [types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L131)* +*Defined in [types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L131)*
@@ -2842,8 +2783,6 @@ ___ - - # Interface: SignedOrder @@ -2855,7 +2794,7 @@ ___ *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* ___ @@ -2865,7 +2804,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -2875,7 +2814,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -2885,7 +2824,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -2895,7 +2834,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -2905,7 +2844,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -2915,7 +2854,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -2925,7 +2864,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* ___ @@ -2935,7 +2874,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -2945,7 +2884,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -2955,7 +2894,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -2963,7 +2902,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -2973,7 +2912,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -2983,7 +2922,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -2993,7 +2932,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -3003,7 +2942,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* ___ @@ -3013,7 +2952,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -3028,7 +2967,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* ___ @@ -3038,7 +2977,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[domain](#domain)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* ___ @@ -3048,7 +2987,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* ___ @@ -3058,7 +2997,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[gasPrice](#gasprice)* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* ___ @@ -3068,7 +3007,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* ___ @@ -3076,7 +3015,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L54)* +*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L54)* ___ @@ -3086,7 +3025,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L48)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)*
@@ -3111,7 +3050,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L191)* +*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L191)* ___ @@ -3119,7 +3058,7 @@ ___ • **callResultHash**: *string* -*Defined in [types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L194)* +*Defined in [types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L194)* ___ @@ -3127,7 +3066,7 @@ ___ • **callTarget**: *string* -*Defined in [types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L192)* +*Defined in [types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L192)* ___ @@ -3135,7 +3074,7 @@ ___ • **staticCallData**: *string* -*Defined in [types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L193)* +*Defined in [types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L193)*
@@ -3176,7 +3115,7 @@ Validator signature components • **signature**: *string* -*Defined in [types/src/index.ts:71](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L71)* +*Defined in [types/src/index.ts:71](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L71)* ___ @@ -3184,7 +3123,7 @@ ___ • **validatorAddress**: *string* -*Defined in [types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L70)* +*Defined in [types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L70)*
@@ -3199,7 +3138,7 @@ ZeroExTransaction for use with 0x Exchange executeTransaction • **data**: *string* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* ___ @@ -3207,7 +3146,7 @@ ___ • **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* ___ @@ -3215,7 +3154,7 @@ ___ • **expirationTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* ___ @@ -3223,7 +3162,7 @@ ___ • **gasPrice**: *`BigNumber`* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* ___ @@ -3231,7 +3170,7 @@ ___ • **salt**: *`BigNumber`* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* ___ @@ -3239,16 +3178,12 @@ ___ • **signerAddress**: *string* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L48)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)*
-
- - - ## Type aliases @@ -3268,7 +3203,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -3285,7 +3220,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -3314,7 +3249,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/44793a9cf/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -3329,7 +3264,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/44793a9cf/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)*
@@ -3358,13 +3293,13 @@ ___ #### ▪ **assetDataUtils**: *object* -*Defined in [order-utils/src/asset_data_utils.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L397)* Throws if the assetData is not ERC1155. @@ -3380,7 +3315,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L353)* Throws if the length or assetProxyId are invalid for the ERC20Proxy. @@ -3396,7 +3331,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L375)* Throws if the length or assetProxyId are invalid for the ERC721Proxy. @@ -3412,7 +3347,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L419)* Throws if the length or assetProxyId are invalid for the MultiAssetProxy. @@ -3428,7 +3363,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L441)* Throws if the assetData is not StaticCallData. @@ -3444,7 +3379,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L463)* Throws if the assetData is not padded to 32 bytes. @@ -3460,7 +3395,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L502)* Decode any assetData into its corresponding assetData object @@ -3478,7 +3413,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L294)* Decode and return the assetProxyId from the assetData @@ -3496,7 +3431,7 @@ The assetProxyId ▸ **decodeDutchAuctionData**(`dutchAuctionData`: string): *`DutchAuctionData`* -*Defined in [order-utils/src/asset_data_utils.ts:263](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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 @@ -3516,7 +3451,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L107)* Decodes an ERC1155 assetData hex string into its corresponding ERC1155 components. @@ -3534,7 +3469,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L41)* Decodes an ERC20 assetData hex string into its corresponding ERC20 tokenAddress & assetProxyId @@ -3552,7 +3487,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L70)* Decodes an ERC721 assetData hex string into its corresponding ERC721 tokenAddress, tokenId & assetProxyId @@ -3570,7 +3505,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L149)* Decodes a MultiAsset assetData hex string into its corresponding amounts and nestedAssetData @@ -3588,7 +3523,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/44793a9cf/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/9fe6c196a/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) @@ -3606,7 +3541,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L225)* Decoded StaticCall assetData into its corresponding callTarget, staticCallData, and expected callResultHash @@ -3624,7 +3559,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/44793a9cf/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/9fe6c196a/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 @@ -3646,7 +3581,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/44793a9cf/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/9fe6c196a/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. @@ -3668,7 +3603,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/44793a9cf/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/9fe6c196a/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. @@ -3687,7 +3622,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/44793a9cf/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/9fe6c196a/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. @@ -3707,7 +3642,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/44793a9cf/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/9fe6c196a/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. @@ -3727,7 +3662,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L214)* Encodes StaticCallProxy data into an assetData hex string @@ -3747,7 +3682,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L332)* Checks if the decoded asset data is valid ERC1155 data @@ -3763,7 +3698,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L318)* Checks if the decoded asset data is valid ERC20 data @@ -3779,7 +3714,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L325)* Checks if the decoded asset data is valid ERC721 data @@ -3795,7 +3730,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L339)* Checks if the decoded asset data is valid MultiAsset data @@ -3811,7 +3746,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L346)* Checks if the decoded asset data is valid StaticCall data @@ -3827,7 +3762,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/asset_data_utils.ts#L475)* Throws if the length or assetProxyId are invalid for the corresponding AssetProxy. @@ -3843,10 +3778,6 @@ Name | Type | Description | -
- - - ## Object literals @@ -3854,15 +3785,15 @@ Name | Type | Description | #### ▪ **eip712Utils**: *object* -*Defined in [order-utils/src/eip712_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/eip712_utils.ts#L17)* +*Defined in [order-utils/src/eip712_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/eip712_utils.ts#L18)* #### createCoordinatorApprovalTypedData -▸ **createCoordinatorApprovalTypedData**(`transaction`: `SignedZeroExTransaction`, `verifyingContract`: string, `txOrigin`: string): *`EIP712TypedData`* +▸ **createCoordinatorApprovalTypedData**(`transaction`: `SignedZeroExTransaction`, `verifyingContract`: string, `txOrigin`: string, `approvalExpirationTimeSeconds`: `BigNumber`): *`EIP712TypedData`* -*Defined in [order-utils/src/eip712_utils.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/eip712_utils.ts#L103)* +*Defined in [order-utils/src/eip712_utils.ts:105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/eip712_utils.ts#L105)* -Creates an Coordinator typedData EIP712TypedData object for use with the Coordinator extension contract +Creates an Coordiantor typedData EIP712TypedData object for use with the Coordinator extension contract **Parameters:** @@ -3871,6 +3802,7 @@ Name | Type | Description | `transaction` | `SignedZeroExTransaction` | A 0x transaction | `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 | +`approvalExpirationTimeSeconds` | `BigNumber` | The approvals expiration time | **Returns:** *`EIP712TypedData`* @@ -3880,7 +3812,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/44793a9cf/packages/order-utils/src/eip712_utils.ts#L56)* +*Defined in [order-utils/src/eip712_utils.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/eip712_utils.ts#L57)* Creates an Order EIP712TypedData object for use with signTypedData. @@ -3898,7 +3830,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/44793a9cf/packages/order-utils/src/eip712_utils.ts#L26)* +*Defined in [order-utils/src/eip712_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/eip712_utils.ts#L27)* Creates a EIP712TypedData object specific to the 0x protocol for use with signTypedData. @@ -3919,7 +3851,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/44793a9cf/packages/order-utils/src/eip712_utils.ts#L81)* +*Defined in [order-utils/src/eip712_utils.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/eip712_utils.ts#L82)* Creates an ExecuteTransaction EIP712TypedData object for use with signTypedData and 0x Exchange executeTransaction. @@ -3961,13 +3893,13 @@ A typed data object #### ▪ **marketUtils**: *object* -*Defined in [order-utils/src/market_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/market_utils.ts#L17)* +*Defined in [order-utils/src/market_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/order-utils/src/market_utils.ts#L64)* +*Defined in [order-utils/src/market_utils.ts:64](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -3994,7 +3926,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/44793a9cf/packages/order-utils/src/market_utils.ts#L40)* +*Defined in [order-utils/src/market_utils.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -4020,7 +3952,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/44793a9cf/packages/order-utils/src/market_utils.ts#L18)* +*Defined in [order-utils/src/market_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/market_utils.ts#L18)* **Type parameters:** @@ -4047,13 +3979,13 @@ Name | Type | #### ▪ **orderCalculationUtils**: *object* -*Defined in [order-utils/src/order_calculation_utils.ts:6](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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/44793a9cf/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/9fe6c196a/packages/order-utils/src/order_calculation_utils.ts#L75)* Given an amount of maker asset, calculate the fee amount required for the maker @@ -4070,7 +4002,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/order_calculation_utils.ts#L36)* Given an amount of taker asset, calculate the the amount of maker asset @@ -4087,7 +4019,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/order_calculation_utils.ts#L62)* Given an amount of taker asset, calculate the fee amount required for the taker @@ -4104,7 +4036,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/44793a9cf/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/9fe6c196a/packages/order-utils/src/order_calculation_utils.ts#L49)* Given an amount of maker asset, calculate the equivalent amount in taker asset @@ -4121,7 +4053,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/44793a9cf/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/9fe6c196a/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 @@ -4139,7 +4071,7 @@ Name | Type | Description | ▸ **isOpenOrder**(`order`: `Order`): *boolean* -*Defined in [order-utils/src/order_calculation_utils.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_calculation_utils.ts#L28)* +*Defined in [order-utils/src/order_calculation_utils.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_calculation_utils.ts#L28)* Determines if the order is open and fillable by any taker. @@ -4155,7 +4087,7 @@ Name | Type | Description | ▸ **isOrderExpired**(`order`: `Order`): *boolean* -*Defined in [order-utils/src/order_calculation_utils.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_calculation_utils.ts#L11)* +*Defined in [order-utils/src/order_calculation_utils.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_calculation_utils.ts#L11)* Determines if the order is expired given the current time @@ -4171,7 +4103,7 @@ Name | Type | Description | ▸ **willOrderExpire**(`order`: `Order`, `secondsFromNow`: number): *boolean* -*Defined in [order-utils/src/order_calculation_utils.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_calculation_utils.ts#L19)* +*Defined in [order-utils/src/order_calculation_utils.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_calculation_utils.ts#L19)* Calculates if the order will expire in the future. @@ -4195,13 +4127,13 @@ Name | Type | Description | #### ▪ **orderHashUtils**: *object* -*Defined in [order-utils/src/order_hash.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_hash.ts#L12)* +*Defined in [order-utils/src/order_hash.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/order-utils/src/order_hash.ts#L55)* +*Defined in [order-utils/src/order_hash.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_hash.ts#L55)* Computes the orderHash for a supplied order @@ -4219,7 +4151,7 @@ A Buffer containing the resulting orderHash from hashing the supplied order ▸ **getOrderHashHex**(`order`: `SignedOrder` | `Order`): *string* -*Defined in [order-utils/src/order_hash.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_hash.ts#L33)* +*Defined in [order-utils/src/order_hash.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/order_hash.ts#L33)* Computes the orderHash for a supplied order. @@ -4237,7 +4169,7 @@ Hex encoded string orderHash from hashing the supplied order. ▸ **isValidOrderHash**(`orderHash`: string): *boolean* -*Defined in [order-utils/src/order_hash.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/order_hash.ts#L20)* +*Defined in [order-utils/src/order_hash.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -4272,13 +4204,13 @@ Whether the supplied orderHash has the expected format. #### ▪ **orderParsingUtils**: *object* -*Defined in [order-utils/src/parsing_utils.ts:4](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/parsing_utils.ts#L4)* +*Defined in [order-utils/src/parsing_utils.ts:4](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/parsing_utils.ts#L4)* #### convertOrderStringFieldsToBigNumber ▸ **convertOrderStringFieldsToBigNumber**(`order`: any): *any* -*Defined in [order-utils/src/parsing_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/parsing_utils.ts#L17)* +*Defined in [order-utils/src/parsing_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/parsing_utils.ts#L17)* **Parameters:** @@ -4292,7 +4224,7 @@ Name | Type | ▸ **convertStringsFieldsToBigNumbers**(`obj`: any, `fields`: string[]): *any* -*Defined in [order-utils/src/parsing_utils.ts:5](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/parsing_utils.ts#L5)* +*Defined in [order-utils/src/parsing_utils.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/parsing_utils.ts#L5)* **Parameters:** @@ -4314,13 +4246,13 @@ Name | Type | #### ▪ **rateUtils**: *object* -*Defined in [order-utils/src/rate_utils.ts:8](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/rate_utils.ts#L8)* +*Defined in [order-utils/src/rate_utils.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/order-utils/src/rate_utils.ts#L36)* +*Defined in [order-utils/src/rate_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -4339,7 +4271,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/44793a9cf/packages/order-utils/src/rate_utils.ts#L18)* +*Defined in [order-utils/src/rate_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -4366,7 +4298,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/44793a9cf/packages/order-utils/src/salt.ts#L9)* +*Defined in [order-utils/src/salt.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -4387,13 +4319,13 @@ A pseudo-random 256-bit number that can be used as a salt. #### ▪ **signatureUtils**: *object* -*Defined in [order-utils/src/signature_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L27)* +*Defined in [order-utils/src/signature_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L27)* #### addSignedMessagePrefix ▸ **addSignedMessagePrefix**(`message`: string): *string* -*Defined in [order-utils/src/signature_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L500)* +*Defined in [order-utils/src/signature_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L500)* Adds the relevant prefix to the message being signed. @@ -4411,7 +4343,7 @@ Prefixed message ▸ **convertECSignatureToSignatureHex**(`ecSignature`: `ECSignature`): *string* -*Defined in [order-utils/src/signature_utils.ts:474](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L474)* +*Defined in [order-utils/src/signature_utils.ts:474](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L474)* Combines ECSignature with V,R,S and the EthSign signature type for use in 0x protocol @@ -4429,7 +4361,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L490)* +*Defined in [order-utils/src/signature_utils.ts:490](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L490)* Combines the signature proof and the Signature Type. @@ -4448,7 +4380,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L417)* +*Defined in [order-utils/src/signature_utils.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L417)* Signs a hash using `eth_sign` and returns its elliptic curve signature and signature type. @@ -4468,7 +4400,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L252)* +*Defined in [order-utils/src/signature_utils.ts:252](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L252)* Signs an order and returns a SignedOrder. First `eth_signTypedData` is requested then a fallback to `eth_sign` if not available on the supplied provider. @@ -4489,7 +4421,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L331)* +*Defined in [order-utils/src/signature_utils.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L331)* Signs a transaction and returns a SignedZeroExTransaction. First `eth_signTypedData` is requested then a fallback to `eth_sign` if not available on the supplied provider. @@ -4510,7 +4442,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L287)* +*Defined in [order-utils/src/signature_utils.ts:287](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L287)* Signs an order using `eth_signTypedData` and returns a SignedOrder. @@ -4530,7 +4462,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/44793a9cf/packages/order-utils/src/signature_utils.ts#L374)* +*Defined in [order-utils/src/signature_utils.ts:374](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L374)* Signs a ZeroExTransaction using `eth_signTypedData` and returns a SignedZeroExTransaction. @@ -4550,7 +4482,7 @@ A SignedZeroExTransaction containing the ZeroExTransaction and Elliptic curve si ▸ **isValidECSignature**(`data`: string, `signature`: `ECSignature`, `signerAddress`: string): *boolean* -*Defined in [order-utils/src/signature_utils.ts:222](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L222)* +*Defined in [order-utils/src/signature_utils.ts:222](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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` @@ -4571,7 +4503,7 @@ Whether the ECSignature is valid. ▸ **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/44793a9cf/packages/order-utils/src/signature_utils.ts#L107)* +*Defined in [order-utils/src/signature_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L107)* Verifies that the provided presigned signature is valid according to the 0x Protocol smart contracts @@ -4592,7 +4524,7 @@ Whether the data was preSigned by the supplied signerAddress ▸ **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/44793a9cf/packages/order-utils/src/signature_utils.ts#L38)* +*Defined in [order-utils/src/signature_utils.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L38)* Verifies that the provided signature is valid according to the 0x Protocol smart contracts @@ -4614,7 +4546,7 @@ Whether the signature is valid for the supplied signerAddress and data. ▸ **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/44793a9cf/packages/order-utils/src/signature_utils.ts#L168)* +*Defined in [order-utils/src/signature_utils.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L168)* Verifies that the provided validator signature is valid according to the 0x Protocol smart contracts @@ -4636,7 +4568,7 @@ Whether the data was preSigned by the supplied signerAddress. ▸ **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/44793a9cf/packages/order-utils/src/signature_utils.ts#L139)* +*Defined in [order-utils/src/signature_utils.ts:139](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L139)* Verifies that the provided wallet signature is valid according to the 0x Protocol smart contracts @@ -4657,7 +4589,7 @@ Whether the data was preSigned by the supplied signerAddress. ▸ **parseECSignature**(`signature`: string): *`ECSignature`* -*Defined in [order-utils/src/signature_utils.ts:512](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L512)* +*Defined in [order-utils/src/signature_utils.ts:512](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L512)* Parse a 0x protocol hex-encoded signature string into its ECSignature components @@ -4675,7 +4607,7 @@ An ECSignature object with r,s,v parameters ▸ **parseValidatorSignature**(`signature`: string): *`ValidatorSignature`* -*Defined in [order-utils/src/signature_utils.ts:529](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/signature_utils.ts#L529)* +*Defined in [order-utils/src/signature_utils.ts:529](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/signature_utils.ts#L529)* Parse a hex-encoded Validator signature into validator address and signature components @@ -4700,13 +4632,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/44793a9cf/packages/order-utils/src/sorting_utils.ts#L10)* +*Defined in [order-utils/src/sorting_utils.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/order-utils/src/sorting_utils.ts#L35)* +*Defined in [order-utils/src/sorting_utils.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -4729,7 +4661,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/44793a9cf/packages/order-utils/src/sorting_utils.ts#L21)* +*Defined in [order-utils/src/sorting_utils.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -4772,13 +4704,13 @@ The input orders sorted by rate in ascending order #### ▪ **transactionHashUtils**: *object* -*Defined in [order-utils/src/transaction_hash.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/transaction_hash.ts#L9)* +*Defined in [order-utils/src/transaction_hash.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/order-utils/src/transaction_hash.ts#L41)* +*Defined in [order-utils/src/transaction_hash.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/transaction_hash.ts#L41)* Computes the transactionHash for a supplied 0x transaction. @@ -4796,7 +4728,7 @@ A Buffer containing the resulting transactionHash from hashing the supplied 0x t ▸ **getTransactionHashHex**(`transaction`: `ZeroExTransaction` | `SignedZeroExTransaction`): *string* -*Defined in [order-utils/src/transaction_hash.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/transaction_hash.ts#L30)* +*Defined in [order-utils/src/transaction_hash.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/order-utils/src/transaction_hash.ts#L30)* Computes the transactionHash for a supplied 0x transaction. @@ -4814,7 +4746,7 @@ Hex encoded string transactionHash from hashing the supplied order. ▸ **isValidTransactionHash**(`transactionHash`: string): *boolean* -*Defined in [order-utils/src/transaction_hash.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/order-utils/src/transaction_hash.ts#L17)* +*Defined in [order-utils/src/transaction_hash.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -4832,3 +4764,58 @@ 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/9fe6c196a/packages/types/src/index.ts#L224)* + +___ + + + + + +### EIP712ObjectValue + +Ƭ **EIP712ObjectValue**: *string | number | [EIP712Object](#interface-eip712object)* + +*Defined in [types/src/index.ts:728](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L728)* + +___ + + + + + +### OrderState + +Ƭ **OrderState**: *[OrderStateValid](#interface-orderstatevalid) | [OrderStateInvalid](#interface-orderstateinvalid)* + +*Defined in [types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/9fe6c196a/packages/types/src/index.ts#L204)* + +
+ diff --git a/packages/orderbook/CHANGELOG.json b/packages/orderbook/CHANGELOG.json index add5c6f49c..15c662c579 100644 --- a/packages/orderbook/CHANGELOG.json +++ b/packages/orderbook/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "0.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "0.1.0-beta.0", "changes": [ diff --git a/packages/orderbook/CHANGELOG.md b/packages/orderbook/CHANGELOG.md index e0446c810f..9f5e9d1237 100644 --- a/packages/orderbook/CHANGELOG.md +++ b/packages/orderbook/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v0.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v0.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/sol-compiler/CHANGELOG.json b/packages/sol-compiler/CHANGELOG.json index c7830f3244..efa2c2c311 100644 --- a/packages/sol-compiler/CHANGELOG.json +++ b/packages/sol-compiler/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "3.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "3.2.0-beta.0", "changes": [ diff --git a/packages/sol-compiler/CHANGELOG.md b/packages/sol-compiler/CHANGELOG.md index 6fe1a2acfc..d848c556b2 100644 --- a/packages/sol-compiler/CHANGELOG.md +++ b/packages/sol-compiler/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v3.2.0-beta.0 - _October 3, 2019_ * Convert `getContractNamesToCompile` to public function of `Compiler` class (#2055) diff --git a/packages/sol-compiler/docs/reference.mdx b/packages/sol-compiler/docs/reference.mdx index 0f51dbcb35..3219d48829 100644 --- a/packages/sol-compiler/docs/reference.mdx +++ b/packages/sol-compiler/docs/reference.mdx @@ -1,3 +1,81 @@ +# 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:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L94)* + +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:132](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L132)* + +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:145](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L145)* + +Compiles Solidity files specified during instantiation, and returns the +compiler output given by solc. Return value is an array of outputs: +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:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L186)* + +Gets a list of contracts to compile. + +**Returns:** *string[]* + +___ + +### watchAsync + +▸ **watchAsync**(): *`Promise`* + +*Defined in [sol-compiler/src/compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-compiler/src/compiler.ts#L149)* + +**Returns:** *`Promise`* + +
@@ -10,11 +88,6 @@ -
- - - - @@ -45,7 +118,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/44793a9cf/packages/ethereum-types/src/index.ts#L731)* +*Defined in [ethereum-types/src/index.ts:731](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L731)* ___ @@ -53,7 +126,7 @@ ___ • **compilerSettings**? : *[CompilerSettings](#class-compilersettings)* -*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L732)* +*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L732)* ___ @@ -61,7 +134,7 @@ ___ • **contracts**? : *string[] | "*"* -*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L733)* +*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L733)* ___ @@ -69,7 +142,7 @@ ___ • **contractsDir**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:730](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L730)* +*Defined in [ethereum-types/src/index.ts:730](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L730)* ___ @@ -77,7 +150,7 @@ ___ • **isOfflineMode**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L735)* +*Defined in [ethereum-types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L735)* ___ @@ -85,7 +158,7 @@ ___ • **solcVersion**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L736)* +*Defined in [ethereum-types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L736)* ___ @@ -93,7 +166,7 @@ ___ • **useDockerisedSolc**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:734](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L734)* +*Defined in [ethereum-types/src/index.ts:734](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L734)*
@@ -108,7 +181,7 @@ ___ • **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L689)* +*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L689)* ___ @@ -116,7 +189,7 @@ ___ • **libraries**? : *undefined | object* -*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L691)* +*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L691)* ___ @@ -124,7 +197,7 @@ ___ • **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* -*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L690)* +*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L690)* ___ @@ -132,7 +205,7 @@ ___ • **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* -*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L688)* +*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L688)* ___ @@ -140,7 +213,7 @@ ___ • **outputSelection**: *object* -*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L696)* +*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L696)* #### Type declaration: @@ -154,7 +227,7 @@ ___ • **remappings**? : *string[]* -*Defined in [ethereum-types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L687)* +*Defined in [ethereum-types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L687)*
@@ -167,7 +240,7 @@ ___ • **useLiteralContent**: *true* -*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L704)* +*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L704)*
@@ -180,7 +253,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L103)* +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L103)* ___ @@ -188,7 +261,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L104)* +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L104)* ___ @@ -196,7 +269,7 @@ ___ • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L105)* +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L105)* ___ @@ -204,7 +277,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L102)* +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L102)*
@@ -223,7 +296,7 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* ___ @@ -231,7 +304,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -239,7 +312,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -256,7 +329,7 @@ ___ • **author**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L628)* +*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L628)* ___ @@ -264,7 +337,7 @@ ___ • **methods**: *object* -*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L629)* +*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L629)* #### Type declaration: @@ -276,7 +349,7 @@ ___ • **title**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L627)* +*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L627)*
@@ -291,7 +364,7 @@ ___ • **anonymous**: *boolean* -*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L131)* +*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L131)* ___ @@ -299,7 +372,7 @@ ___ • **inputs**: *[EventParameter](#class-eventparameter)[]* -*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L130)* +*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L130)* ___ @@ -307,7 +380,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L129)* +*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L129)* ___ @@ -315,7 +388,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L128)* +*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L128)*
@@ -330,7 +403,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* ___ @@ -338,7 +411,7 @@ ___ • **indexed**: *boolean* -*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L116)* +*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L116)* ___ @@ -348,7 +421,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -358,7 +431,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -371,7 +444,7 @@ ___ • **object**: *string* -*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L622)* +*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L622)* ___ @@ -379,7 +452,7 @@ ___ • **sourceMap**: *string* -*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L623)* +*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L623)*
@@ -392,7 +465,7 @@ ___ • **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L617)* +*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L617)* ___ @@ -400,7 +473,7 @@ ___ • **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L618)* +*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L618)*
@@ -413,7 +486,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L112)* +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L112)* ___ @@ -421,90 +494,13 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L111)* +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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:97](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/packages/sol-compiler/src/compiler.ts#L155)* - -**Returns:** *`Promise`* - -
@@ -529,7 +525,7 @@ ___ • **constant**: *boolean* -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L94)* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L94)* ___ @@ -537,7 +533,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L92)* +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L92)* ___ @@ -545,7 +541,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L91)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L91)* ___ @@ -553,7 +549,7 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L93)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L93)* ___ @@ -561,7 +557,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L96)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L96)* ___ @@ -569,7 +565,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L95)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L95)* ___ @@ -577,7 +573,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L90)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L90)*
@@ -590,7 +586,7 @@ ___ • **enabled**: *boolean* -*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L708)* +*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L708)* ___ @@ -598,7 +594,7 @@ ___ • **runs**? : *undefined | number* -*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L709)* +*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L709)*
@@ -615,7 +611,7 @@ ___ • **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L122)* +*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L122)* ___ @@ -623,7 +619,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L121)* +*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L121)* ___ @@ -631,7 +627,7 @@ ___ • **type**: *"error"* -*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L120)* +*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L120)*
@@ -644,7 +640,7 @@ ___ • **component**: *"general" | "ewasm"* -*Defined in [ethereum-types/src/index.ts:604](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L604)* +*Defined in [ethereum-types/src/index.ts:604](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L604)* ___ @@ -652,7 +648,7 @@ ___ • **formattedMessage**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:607](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L607)* +*Defined in [ethereum-types/src/index.ts:607](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L607)* ___ @@ -660,7 +656,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:606](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L606)* +*Defined in [ethereum-types/src/index.ts:606](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L606)* ___ @@ -668,7 +664,7 @@ ___ • **severity**: *[ErrorSeverity](#errorseverity)* -*Defined in [ethereum-types/src/index.ts:605](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L605)* +*Defined in [ethereum-types/src/index.ts:605](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L605)* ___ @@ -676,7 +672,7 @@ ___ • **sourceLocation**? : *[SourceLocation](#class-sourcelocation)* -*Defined in [ethereum-types/src/index.ts:602](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L602)* +*Defined in [ethereum-types/src/index.ts:602](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L602)* ___ @@ -684,7 +680,7 @@ ___ • **type**: *[ErrorType](#errortype)* -*Defined in [ethereum-types/src/index.ts:603](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L603)* +*Defined in [ethereum-types/src/index.ts:603](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L603)*
@@ -701,7 +697,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L564)* +*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L564)* ___ @@ -709,7 +705,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L566)* +*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L566)* ___ @@ -717,7 +713,7 @@ ___ • **evm**: *[EvmOutput](#class-evmoutput)* -*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L565)* +*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L565)*
@@ -730,7 +726,7 @@ ___ • **contracts**: *object* -*Defined in [ethereum-types/src/index.ts:578](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L578)* +*Defined in [ethereum-types/src/index.ts:578](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L578)* #### Type declaration: @@ -744,7 +740,7 @@ ___ • **errors**: *[SolcError](#class-solcerror)[]* -*Defined in [ethereum-types/src/index.ts:570](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L570)* +*Defined in [ethereum-types/src/index.ts:570](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L570)* ___ @@ -752,7 +748,7 @@ ___ • **sources**: *object* -*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L571)* +*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L571)* #### Type declaration: @@ -783,7 +779,7 @@ ___ *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/44793a9cf/packages/ethereum-types/src/index.ts#L141)* +*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L141)* ___ @@ -793,7 +789,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -803,7 +799,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -828,7 +824,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/44793a9cf/packages/ethereum-types/src/index.ts#L80)* +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L80)* ___ @@ -838,7 +834,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L84)* ___ @@ -846,7 +842,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L78)* +*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L78)* ___ @@ -860,7 +856,7 @@ ___ Ƭ **ErrorSeverity**: *"error" | "warning"* -*Defined in [ethereum-types/src/index.ts:599](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L599)* +*Defined in [ethereum-types/src/index.ts:599](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L599)* ___ @@ -868,7 +864,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/44793a9cf/packages/ethereum-types/src/index.ts#L585)* +*Defined in [ethereum-types/src/index.ts:585](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L585)* ___ @@ -876,7 +872,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/44793a9cf/packages/ethereum-types/src/index.ts#L82)* +*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L82)* ___ @@ -888,7 +884,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/44793a9cf/packages/ethereum-types/src/index.ts#L525)* +*Defined in [ethereum-types/src/index.ts:525](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L525)* ___ @@ -896,7 +892,7 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L561)* +*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L561)* ___ @@ -906,7 +902,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L85)* ___ @@ -918,3 +914,7 @@ ___ + + +
+ diff --git a/packages/sol-coverage/CHANGELOG.json b/packages/sol-coverage/CHANGELOG.json index efd938ea5c..791dd3c6d5 100644 --- a/packages/sol-coverage/CHANGELOG.json +++ b/packages/sol-coverage/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "3.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "3.1.0-beta.0", "changes": [ diff --git a/packages/sol-coverage/CHANGELOG.md b/packages/sol-coverage/CHANGELOG.md index 750dcc89ad..48a4aa8ddb 100644 --- a/packages/sol-coverage/CHANGELOG.md +++ b/packages/sol-coverage/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v3.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/sol-coverage/docs/reference.mdx b/packages/sol-coverage/docs/reference.mdx index 40851e9525..3d48323485 100644 --- a/packages/sol-coverage/docs/reference.mdx +++ b/packages/sol-coverage/docs/reference.mdx @@ -1,367 +1,3 @@ - - -# 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/44793a9cf/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/44793a9cf/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 - -▸ **collectContractsDataAsync**(): *`Promise`* - -*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* - -*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* - -**Returns:** *`Promise`* - -
- -# Class: TruffleArtifactAdapter - - -## Constructors - - - -\+ **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/44793a9cf/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* - -Instantiates a TruffleArtifactAdapter - -**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)* - -*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* - -**Returns:** *`Promise`* - -
- - - - - - - - - - - - - - - - - - - - -## Type aliases - -### Callback - -Ƭ **Callback**: *function* - -*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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) | - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -# Interface: JSONRPCRequestPayload - - -## Properties - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* - -___ - -### method - -• **method**: *string* - -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* - -___ - -### params - -• **params**: *any[]* - -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* - -
- -# Interface: JSONRPCResponseError - - -## Properties - -### code - -• **code**: *number* - -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* - -___ - -### message - -• **message**: *string* - -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* - -
- -# Interface: JSONRPCResponsePayload - - -## Properties - -### `Optional` error - -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* - -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* - -___ - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* - -___ - -### result - -• **result**: *any* - -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Class: CoverageSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. @@ -376,7 +12,7 @@ It's used to compute your code coverage while running solidity tests. *Overrides void* -*Defined in [sol-coverage/src/coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-coverage/src/coverage_subprovider.ts#L44)* +*Defined in [sol-coverage/src/coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L44)* Instantiates a CoverageSubprovider instance @@ -498,7 +134,7 @@ ___ ▸ **writeCoverageAsync**(): *`Promise`* -*Defined in [sol-coverage/src/coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-coverage/src/coverage_subprovider.ts#L78)* +*Defined in [sol-coverage/src/coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L78)* Write the test coverage results to a file in Istanbul format. @@ -506,6 +142,292 @@ Write the test coverage results to a file in Istanbul format.
+# 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/9fe6c196a/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/9fe6c196a/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 + +▸ **collectContractsDataAsync**(): *`Promise`* + +*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* + +*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* + +**Returns:** *`Promise`* + +
+ +# Class: TruffleArtifactAdapter + + +## Constructors + + + +\+ **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/9fe6c196a/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* + +Instantiates a TruffleArtifactAdapter + +**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)* + +*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* + +**Returns:** *`Promise`* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Interface: JSONRPCRequestPayload + + +## Properties + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* + +___ + +### method + +• **method**: *string* + +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* + +___ + +### params + +• **params**: *any[]* + +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)* + +
+ +# Interface: JSONRPCResponseError + + +## Properties + +### code + +• **code**: *number* + +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* + +___ + +### message + +• **message**: *string* + +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)* + +
+ +# Interface: JSONRPCResponsePayload + + +## Properties + +### `Optional` error + +• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* + +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* + +___ + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* + +___ + +### result + +• **result**: *any* + +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -595,7 +517,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L136)* +*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L136)* ___ @@ -655,19 +577,6 @@ Defined in ethereum-types/lib/index.d.ts:265 -## Type aliases - - - - - - - - - - - - @@ -706,7 +615,7 @@ Defined in ethereum-types/lib/index.d.ts:265 Ƭ **CoverageSubproviderPartialConfig**: *`Partial`* -*Defined in [sol-coverage/src/coverage_subprovider.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-coverage/src/coverage_subprovider.ts#L31)* +*Defined in [sol-coverage/src/coverage_subprovider.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L31)* ## Object literals @@ -714,19 +623,19 @@ Defined in ethereum-types/lib/index.d.ts:265 #### ▪ **DEFAULT_COVERAGE_SUBPROVIDER_CONFIG**: *object* -*Defined in [sol-coverage/src/coverage_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-coverage/src/coverage_subprovider.ts#L33)* +*Defined in [sol-coverage/src/coverage_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/sol-coverage/src/coverage_subprovider.ts#L35)* +*Defined in [sol-coverage/src/coverage_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/44793a9cf/packages/sol-coverage/src/coverage_subprovider.ts#L34)* +*Defined in [sol-coverage/src/coverage_subprovider.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-coverage/src/coverage_subprovider.ts#L34)*
@@ -742,3 +651,94 @@ Defined in ethereum-types/lib/index.d.ts:265
+ + + +## Type aliases + + + + + + + + + + + + +## Type aliases + +### Callback + +Ƭ **Callback**: *function* + +*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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-doc/CHANGELOG.json b/packages/sol-doc/CHANGELOG.json index d85d0a917e..89ae9ceea5 100644 --- a/packages/sol-doc/CHANGELOG.json +++ b/packages/sol-doc/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.1.0-beta.0", "changes": [ diff --git a/packages/sol-doc/CHANGELOG.md b/packages/sol-doc/CHANGELOG.md index 8243926c26..aeaf0294a3 100644 --- a/packages/sol-doc/CHANGELOG.md +++ b/packages/sol-doc/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/sol-profiler/CHANGELOG.json b/packages/sol-profiler/CHANGELOG.json index 371f90d637..c8b7df531d 100644 --- a/packages/sol-profiler/CHANGELOG.json +++ b/packages/sol-profiler/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "3.2.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "3.2.0-beta.0", "changes": [ diff --git a/packages/sol-profiler/CHANGELOG.md b/packages/sol-profiler/CHANGELOG.md index 19e278dcec..24edb2152c 100644 --- a/packages/sol-profiler/CHANGELOG.md +++ b/packages/sol-profiler/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.2.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v3.2.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/sol-profiler/docs/reference.mdx b/packages/sol-profiler/docs/reference.mdx index c06750f986..a4182b1098 100644 --- a/packages/sol-profiler/docs/reference.mdx +++ b/packages/sol-profiler/docs/reference.mdx @@ -1,367 +1,3 @@ - - -# 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/44793a9cf/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/44793a9cf/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 - -▸ **collectContractsDataAsync**(): *`Promise`* - -*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* - -*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* - -**Returns:** *`Promise`* - -
- -# Class: TruffleArtifactAdapter - - -## Constructors - - - -\+ **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/44793a9cf/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* - -Instantiates a TruffleArtifactAdapter - -**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)* - -*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* - -**Returns:** *`Promise`* - -
- - - - - - - - - - - - - - - - - - - - -## Type aliases - -### Callback - -Ƭ **Callback**: *function* - -*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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) | - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -# Interface: JSONRPCRequestPayload - - -## Properties - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* - -___ - -### method - -• **method**: *string* - -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* - -___ - -### params - -• **params**: *any[]* - -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* - -
- -# Interface: JSONRPCResponseError - - -## Properties - -### code - -• **code**: *number* - -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* - -___ - -### message - -• **message**: *string* - -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* - -
- -# Interface: JSONRPCResponsePayload - - -## Properties - -### `Optional` error - -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* - -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* - -___ - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* - -___ - -### result - -• **result**: *any* - -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Class: ProfilerSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. @@ -376,7 +12,7 @@ ProfilerSubprovider is used to profile Solidity code while running tests. *Overrides void* -*Defined in [sol-profiler/src/profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-profiler/src/profiler_subprovider.ts#L30)* +*Defined in [sol-profiler/src/profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-profiler/src/profiler_subprovider.ts#L30)* Instantiates a ProfilerSubprovider instance @@ -498,7 +134,7 @@ ___ ▸ **writeProfilerOutputAsync**(): *`Promise`* -*Defined in [sol-profiler/src/profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-profiler/src/profiler_subprovider.ts#L104)* +*Defined in [sol-profiler/src/profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-profiler/src/profiler_subprovider.ts#L104)* Write the test profiler results to a file in Istanbul format. @@ -506,6 +142,292 @@ Write the test profiler results to a file in Istanbul format.
+# 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/9fe6c196a/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/9fe6c196a/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 + +▸ **collectContractsDataAsync**(): *`Promise`* + +*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* + +*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* + +**Returns:** *`Promise`* + +
+ +# Class: TruffleArtifactAdapter + + +## Constructors + + + +\+ **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/9fe6c196a/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* + +Instantiates a TruffleArtifactAdapter + +**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)* + +*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* + +**Returns:** *`Promise`* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Interface: JSONRPCRequestPayload + + +## Properties + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* + +___ + +### method + +• **method**: *string* + +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* + +___ + +### params + +• **params**: *any[]* + +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)* + +
+ +# Interface: JSONRPCResponseError + + +## Properties + +### code + +• **code**: *number* + +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* + +___ + +### message + +• **message**: *string* + +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)* + +
+ +# Interface: JSONRPCResponsePayload + + +## Properties + +### `Optional` error + +• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* + +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* + +___ + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* + +___ + +### result + +• **result**: *any* + +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -593,7 +515,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L136)* +*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L136)* ___ @@ -653,19 +575,6 @@ Defined in ethereum-types/lib/index.d.ts:265 -## Type aliases - - - - - - - - - - - - @@ -704,7 +613,7 @@ Defined in ethereum-types/lib/index.d.ts:265 ▸ **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/44793a9cf/packages/sol-profiler/src/profiler_subprovider.ts#L118)* +*Defined in [sol-profiler/src/profiler_subprovider.ts:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-profiler/src/profiler_subprovider.ts#L118)* Computed partial coverage for a single file & subtrace for the purposes of gas profiling. @@ -736,3 +645,94 @@ Partial istanbul coverage for that file & subtrace
+ + + +## Type aliases + + + + + + + + + + + + +## Type aliases + +### Callback + +Ƭ **Callback**: *function* + +*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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-resolver/CHANGELOG.json b/packages/sol-resolver/CHANGELOG.json index dc94f5ac03..d8bbdd3b4d 100644 --- a/packages/sol-resolver/CHANGELOG.json +++ b/packages/sol-resolver/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.1.0-beta.0", "changes": [ diff --git a/packages/sol-resolver/CHANGELOG.md b/packages/sol-resolver/CHANGELOG.md index d98491731d..b5d9e90583 100644 --- a/packages/sol-resolver/CHANGELOG.md +++ b/packages/sol-resolver/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/sol-trace/CHANGELOG.json b/packages/sol-trace/CHANGELOG.json index d5a6cfc5ab..b5dc26f1b7 100644 --- a/packages/sol-trace/CHANGELOG.json +++ b/packages/sol-trace/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.1.0-beta.0", "changes": [ diff --git a/packages/sol-trace/CHANGELOG.md b/packages/sol-trace/CHANGELOG.md index f6dd6671d6..f111048b0e 100644 --- a/packages/sol-trace/CHANGELOG.md +++ b/packages/sol-trace/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/sol-trace/docs/reference.mdx b/packages/sol-trace/docs/reference.mdx index 4fa654521a..da74c459cd 100644 --- a/packages/sol-trace/docs/reference.mdx +++ b/packages/sol-trace/docs/reference.mdx @@ -1,367 +1,3 @@ - - -# 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/44793a9cf/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/44793a9cf/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 - -▸ **collectContractsDataAsync**(): *`Promise`* - -*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* - -*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* - -**Returns:** *`Promise`* - -
- -# Class: TruffleArtifactAdapter - - -## Constructors - - - -\+ **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/44793a9cf/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* - -Instantiates a TruffleArtifactAdapter - -**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)* - -*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* - -**Returns:** *`Promise`* - -
- - - - - - - - - - - - - - - - - - - - -## Type aliases - -### Callback - -Ƭ **Callback**: *function* - -*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/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/44793a9cf/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/44793a9cf/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) | - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -# Interface: JSONRPCRequestPayload - - -## Properties - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* - -___ - -### method - -• **method**: *string* - -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* - -___ - -### params - -• **params**: *any[]* - -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* - -
- -# Interface: JSONRPCResponseError - - -## Properties - -### code - -• **code**: *number* - -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* - -___ - -### message - -• **message**: *string* - -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* - -
- -# Interface: JSONRPCResponsePayload - - -## Properties - -### `Optional` error - -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* - -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* - -___ - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* - -___ - -### result - -• **result**: *any* - -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - # Class: RevertTraceSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. @@ -376,7 +12,7 @@ It is used to report call stack traces whenever a revert occurs. *Overrides void* -*Defined in [sol-trace/src/revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/sol-trace/src/revert_trace_subprovider.ts#L27)* +*Defined in [sol-trace/src/revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-trace/src/revert_trace_subprovider.ts#L27)* Instantiates a RevertTraceSubprovider instance @@ -494,6 +130,292 @@ Stops trace collection
+# 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/9fe6c196a/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/9fe6c196a/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 + +▸ **collectContractsDataAsync**(): *`Promise`* + +*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* + +*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* + +**Returns:** *`Promise`* + +
+ +# Class: TruffleArtifactAdapter + + +## Constructors + + + +\+ **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/9fe6c196a/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* + +Instantiates a TruffleArtifactAdapter + +**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)* + +*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* + +**Returns:** *`Promise`* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Interface: JSONRPCRequestPayload + + +## Properties + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* + +___ + +### method + +• **method**: *string* + +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* + +___ + +### params + +• **params**: *any[]* + +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)* + +
+ +# Interface: JSONRPCResponseError + + +## Properties + +### code + +• **code**: *number* + +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* + +___ + +### message + +• **message**: *string* + +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)* + +
+ +# Interface: JSONRPCResponsePayload + + +## Properties + +### `Optional` error + +• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* + +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* + +___ + +### id + +• **id**: *number* + +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* + +___ + +### jsonrpc + +• **jsonrpc**: *string* + +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* + +___ + +### result + +• **result**: *any* + +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -581,7 +503,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L136)* +*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L136)* ___ @@ -641,6 +563,54 @@ Defined in ethereum-types/lib/index.d.ts:265 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+ + + +
+ + + + ## Type aliases @@ -654,48 +624,78 @@ 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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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/9fe6c196a/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 2d4d19cdb1..9996466552 100644 --- a/packages/sol-tracing-utils/CHANGELOG.json +++ b/packages/sol-tracing-utils/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "6.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "6.1.0-beta.0", "changes": [ diff --git a/packages/sol-tracing-utils/CHANGELOG.md b/packages/sol-tracing-utils/CHANGELOG.md index 22479de4a0..30f7884801 100644 --- a/packages/sol-tracing-utils/CHANGELOG.md +++ b/packages/sol-tracing-utils/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v6.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v6.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/sra-spec/CHANGELOG.json b/packages/sra-spec/CHANGELOG.json index a475912df7..b6085d18d7 100644 --- a/packages/sra-spec/CHANGELOG.json +++ b/packages/sra-spec/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "2.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "2.1.0-beta.0", "changes": [ diff --git a/packages/sra-spec/CHANGELOG.md b/packages/sra-spec/CHANGELOG.md index c59e64160b..066e399a61 100644 --- a/packages/sra-spec/CHANGELOG.md +++ b/packages/sra-spec/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v2.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/subproviders/CHANGELOG.json b/packages/subproviders/CHANGELOG.json index 7d7052ba07..718b2d2e36 100644 --- a/packages/subproviders/CHANGELOG.json +++ b/packages/subproviders/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "5.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "5.1.0-beta.0", "changes": [ diff --git a/packages/subproviders/CHANGELOG.md b/packages/subproviders/CHANGELOG.md index 9be26c9b9b..b0b9fac5a1 100644 --- a/packages/subproviders/CHANGELOG.md +++ b/packages/subproviders/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v5.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v5.1.0-beta.0 - _October 3, 2019_ * Dependencies updated diff --git a/packages/subproviders/docs/reference.mdx b/packages/subproviders/docs/reference.mdx index 3658eaec2c..a0ad4f0629 100644 --- a/packages/subproviders/docs/reference.mdx +++ b/packages/subproviders/docs/reference.mdx @@ -1,30 +1,10 @@ - - -# Class: FakeGasEstimateSubprovider +# Class: EmptyWalletSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It intercepts the `eth_estimateGas` JSON RPC call and always returns a constant gas amount when queried. +It intercepts the `eth_accounts` JSON RPC requests and never returns any addresses when queried. -## Constructors - - - -\+ **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/44793a9cf/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L17)* - -Instantiates an instance of the FakeGasEstimateSubprovider - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`constantGasAmount` | number | The constant gas amount you want returned | - -**Returns:** *[FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider)* - -## Methods +## Methods ### emitPayloadAsync @@ -32,7 +12,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -56,7 +36,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/44793a9cf/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L35)* +*Defined in [subproviders/src/subproviders/empty_wallet_subprovider.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -80,7 +60,103 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/subprovider.ts#L68)* + +Set's the subprovider's engine to the ProviderEngine it is added to. +This is only called within the ProviderEngine source code, do not call +directly. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | + +**Returns:** *void* + +
+ +# Class: FakeGasEstimateSubprovider + +This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. +It intercepts the `eth_estimateGas` JSON RPC call and always returns a constant gas amount when queried. + + +## Constructors + + + +\+ **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/9fe6c196a/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L17)* + +Instantiates an instance of the FakeGasEstimateSubprovider + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`constantGasAmount` | number | The constant gas amount you want returned | + +**Returns:** *[FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider)* + +## 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/9fe6c196a/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/fake_gas_estimate_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 +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/9fe6c196a/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 @@ -108,7 +184,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/44793a9cf/packages/subproviders/src/subproviders/ganache.ts#L13)* +*Defined in [subproviders/src/subproviders/ganache.ts:13](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/ganache.ts#L13)* Instantiates a GanacheSubprovider @@ -128,7 +204,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -152,7 +228,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/44793a9cf/packages/subproviders/src/subproviders/ganache.ts#L31)* +*Defined in [subproviders/src/subproviders/ganache.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -176,7 +252,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -205,7 +281,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/44793a9cf/packages/subproviders/src/subproviders/ledger.ts#L41)* +*Defined in [subproviders/src/subproviders/ledger.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -228,7 +304,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -252,7 +328,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/ledger.ts:87](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/ledger.ts#L87)* +*Defined in [subproviders/src/subproviders/ledger.ts:87](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -276,7 +352,7 @@ ___ ▸ **getPath**(): *string* -*Defined in [subproviders/src/subproviders/ledger.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/ledger.ts#L68)* +*Defined in [subproviders/src/subproviders/ledger.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/ledger.ts#L68)* Retrieve the set derivation path @@ -294,7 +370,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/44793a9cf/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/9fe6c196a/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 @@ -318,7 +394,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -338,7 +414,7 @@ ___ ▸ **setPath**(`basDerivationPath`: string): *void* -*Defined in [subproviders/src/subproviders/ledger.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/ledger.ts#L75)* +*Defined in [subproviders/src/subproviders/ledger.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/ledger.ts#L75)* Set a desired derivation path when computing the available user addresses @@ -358,7 +434,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/ledger.ts:158](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/ledger.ts#L158)* +*Defined in [subproviders/src/subproviders/ledger.ts:158](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -386,7 +462,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/ledger.ts:101](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/ledger.ts#L101)* +*Defined in [subproviders/src/subproviders/ledger.ts:101](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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` @@ -411,7 +487,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/ledger.ts:196](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/ledger.ts#L196)* +*Defined in [subproviders/src/subproviders/ledger.ts:196](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/ledger.ts#L196)* eth_signTypedData is currently not supported on Ledger devices. @@ -444,7 +520,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/44793a9cf/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* Instantiates a new MetamaskSubprovider @@ -464,7 +540,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -488,7 +564,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/44793a9cf/packages/subproviders/src/subproviders/metamask_subprovider.ts#L39)* +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -510,7 +586,7 @@ ___ ▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/metamask_subprovider.ts#L117)* +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -535,7 +611,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -564,7 +640,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/44793a9cf/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L27)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -587,7 +663,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -611,7 +687,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L70)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -633,7 +709,7 @@ ___ ▸ **getPath**(): *string* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L52)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L52)* Retrieve the set derivation path @@ -651,7 +727,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/44793a9cf/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/9fe6c196a/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 @@ -675,7 +751,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -695,7 +771,7 @@ ___ ▸ **setPath**(`baseDerivationPath`: string): *void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:59](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L59)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L59)* Set a desired derivation path when computing the available user addresses @@ -715,7 +791,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:102](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L102)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -742,7 +818,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L84)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -767,7 +843,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L122)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -803,7 +879,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -827,7 +903,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/44793a9cf/packages/subproviders/src/subproviders/nonce_tracker.ts#L57)* +*Defined in [subproviders/src/subproviders/nonce_tracker.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -851,7 +927,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -880,7 +956,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/44793a9cf/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/9fe6c196a/packages/subproviders/src/subproviders/private_key_wallet.ts#L19)* Instantiates a PrivateKeyWalletSubprovider. @@ -902,7 +978,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -926,7 +1002,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/private_key_wallet.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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 @@ -946,7 +1022,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/44793a9cf/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/9fe6c196a/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 @@ -970,7 +1046,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -992,7 +1068,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/private_key_wallet.ts:72](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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. @@ -1019,7 +1095,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/private_key_wallet.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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 @@ -1044,7 +1120,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/private_key_wallet.ts:99](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/9fe6c196a/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. @@ -1078,7 +1154,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/44793a9cf/packages/subproviders/src/subproviders/redundant_subprovider.ts#L33)* +*Defined in [subproviders/src/subproviders/redundant_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/redundant_subprovider.ts#L33)* Instantiates a new RedundantSubprovider @@ -1098,7 +1174,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1122,7 +1198,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/44793a9cf/packages/subproviders/src/subproviders/redundant_subprovider.ts#L51)* +*Defined in [subproviders/src/subproviders/redundant_subprovider.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1161,7 +1237,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1189,7 +1265,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/44793a9cf/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* +*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* **Parameters:** @@ -1208,7 +1284,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1232,7 +1308,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/44793a9cf/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* +*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1256,7 +1332,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1286,7 +1362,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/44793a9cf/packages/subproviders/src/subproviders/signer.ts#L15)* +*Defined in [subproviders/src/subproviders/signer.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/signer.ts#L15)* Instantiates a new SignerSubprovider. @@ -1306,7 +1382,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1330,7 +1406,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/44793a9cf/packages/subproviders/src/subproviders/signer.ts#L33)* +*Defined in [subproviders/src/subproviders/signer.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1354,7 +1430,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1382,7 +1458,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1404,7 +1480,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L42)* +*Defined in [subproviders/src/subproviders/subprovider.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/subprovider.ts#L42)* **Parameters:** @@ -1422,7 +1498,7 @@ ___ ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1447,7 +1523,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/44793a9cf/packages/subproviders/src/subproviders/trezor.ts#L32)* +*Defined in [subproviders/src/subproviders/trezor.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -1470,7 +1546,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/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1494,7 +1570,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/trezor.ts:56](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/trezor.ts#L56)* +*Defined in [subproviders/src/subproviders/trezor.ts:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1520,7 +1596,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/44793a9cf/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/9fe6c196a/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 @@ -1544,7 +1620,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1566,7 +1642,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/trezor.ts:129](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/trezor.ts#L129)* +*Defined in [subproviders/src/subproviders/trezor.ts:129](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -1593,7 +1669,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/trezor.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/trezor.ts#L70)* +*Defined in [subproviders/src/subproviders/trezor.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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` @@ -1618,7 +1694,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/trezor.ts:161](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/subproviders/trezor.ts#L161)* +*Defined in [subproviders/src/subproviders/trezor.ts:161](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/subproviders/trezor.ts#L161)* TODO:: eth_signTypedData is currently not supported on Trezor devices. @@ -1654,7 +1730,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/44793a9cf/packages/subproviders/src/types.ts#L121)* +*Defined in [subproviders/src/types.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L121)* ___ @@ -1662,7 +1738,7 @@ ___ • **EmptyParametersFound**: = "EMPTY_PARAMETERS_FOUND" -*Defined in [subproviders/src/types.ts:120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L120)* +*Defined in [subproviders/src/types.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L120)*
@@ -1695,39 +1771,6 @@ ___ -## Type aliases - - - - - - - - - -### EIP712ObjectValue - -Ƭ **EIP712ObjectValue**: *string | number | [EIP712Object](#interface-eip712object)* - -*Defined in [types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L740)* - -___ - - - - - - - - - - - - - - - - @@ -1770,7 +1813,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -1778,7 +1821,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -1802,7 +1845,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -1836,7 +1879,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/44793a9cf/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -1860,7 +1903,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* ___ @@ -1868,7 +1911,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* ___ @@ -1876,7 +1919,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* ___ @@ -1884,7 +1927,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)*
@@ -1897,7 +1940,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* ___ @@ -1905,7 +1948,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)*
@@ -1918,7 +1961,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* ___ @@ -1926,7 +1969,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* ___ @@ -1934,7 +1977,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* ___ @@ -1942,7 +1985,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
@@ -2003,7 +2046,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/44793a9cf/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -2019,7 +2062,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/44793a9cf/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -2045,7 +2088,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/44793a9cf/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -2071,7 +2114,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/44793a9cf/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -2097,7 +2140,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ @@ -2105,7 +2148,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ @@ -2113,7 +2156,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -2121,7 +2164,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -2131,7 +2174,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/44793a9cf/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -2148,7 +2191,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -2168,7 +2211,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/44793a9cf/packages/subproviders/src/types.ts#L55)* +*Defined in [subproviders/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L55)* ___ @@ -2176,7 +2219,7 @@ ___ • **numAddressesToReturn**? : *undefined | number* -*Defined in [subproviders/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L56)* +*Defined in [subproviders/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L56)* ___ @@ -2184,7 +2227,7 @@ ___ • **shouldAskForOnDeviceConfirmation**? : *undefined | false | true* -*Defined in [subproviders/src/types.ts:57](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L57)* +*Defined in [subproviders/src/types.ts:57](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L57)*
@@ -2199,7 +2242,7 @@ ___ • **r**: *string* -*Defined in [subproviders/src/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L29)* +*Defined in [subproviders/src/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L29)* ___ @@ -2207,7 +2250,7 @@ ___ • **s**: *string* -*Defined in [subproviders/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L30)* +*Defined in [subproviders/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L30)* ___ @@ -2215,7 +2258,7 @@ ___ • **v**: *string* -*Defined in [subproviders/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L28)* +*Defined in [subproviders/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L28)*
@@ -2250,7 +2293,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L136)* +*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L136)* ___ @@ -2282,7 +2325,7 @@ NodeJs and Browser communication are supported. • **getAddress**: *function* -*Defined in [subproviders/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L17)* +*Defined in [subproviders/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L17)* #### Type declaration: @@ -2302,7 +2345,7 @@ ___ • **signPersonalMessage**: *function* -*Defined in [subproviders/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L23)* +*Defined in [subproviders/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L23)* #### Type declaration: @@ -2321,7 +2364,7 @@ ___ • **signTransaction**: *function* -*Defined in [subproviders/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L22)* +*Defined in [subproviders/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L22)* #### Type declaration: @@ -2340,7 +2383,7 @@ ___ • **transport**: *[LedgerCommunicationClient](#class-ledgercommunicationclient)* -*Defined in [subproviders/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L24)* +*Defined in [subproviders/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L24)*
@@ -2353,7 +2396,7 @@ ___ • **address**: *string* -*Defined in [subproviders/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L79)* +*Defined in [subproviders/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L79)* ___ @@ -2361,7 +2404,7 @@ ___ • **chainCode**: *string* -*Defined in [subproviders/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L81)* +*Defined in [subproviders/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L81)* ___ @@ -2369,7 +2412,7 @@ ___ • **publicKey**: *string* -*Defined in [subproviders/src/types.ts:80](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L80)* +*Defined in [subproviders/src/types.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L80)*
@@ -2387,7 +2430,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/44793a9cf/packages/subproviders/src/types.ts#L45)* +*Defined in [subproviders/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L45)* ___ @@ -2395,7 +2438,7 @@ ___ • **baseDerivationPath**? : *undefined | string* -*Defined in [subproviders/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L44)* +*Defined in [subproviders/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L44)* ___ @@ -2403,7 +2446,7 @@ ___ • **ledgerEthereumClientFactoryAsync**: *[LedgerEthereumClientFactoryAsync](#ledgerethereumclientfactoryasync)* -*Defined in [subproviders/src/types.ts:43](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L43)* +*Defined in [subproviders/src/types.ts:43](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L43)* ___ @@ -2411,7 +2454,7 @@ ___ • **networkId**: *number* -*Defined in [subproviders/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L42)* +*Defined in [subproviders/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L42)*
@@ -2428,7 +2471,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/44793a9cf/packages/subproviders/src/types.ts#L67)* +*Defined in [subproviders/src/types.ts:67](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L67)* ___ @@ -2436,7 +2479,7 @@ ___ • **baseDerivationPath**? : *undefined | string* -*Defined in [subproviders/src/types.ts:68](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L68)* +*Defined in [subproviders/src/types.ts:68](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L68)* ___ @@ -2444,7 +2487,7 @@ ___ • **mnemonic**: *string* -*Defined in [subproviders/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L66)* +*Defined in [subproviders/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L66)*
@@ -2457,7 +2500,7 @@ ___ • **chainId**: *number* -*Defined in [subproviders/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L92)* +*Defined in [subproviders/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L92)* ___ @@ -2465,7 +2508,7 @@ ___ • **data**? : *undefined | string* -*Defined in [subproviders/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L91)* +*Defined in [subproviders/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L91)* ___ @@ -2473,7 +2516,7 @@ ___ • **from**: *string* -*Defined in [subproviders/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L89)* +*Defined in [subproviders/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L89)* ___ @@ -2481,7 +2524,7 @@ ___ • **gas**: *string* -*Defined in [subproviders/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L87)* +*Defined in [subproviders/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L87)* ___ @@ -2489,7 +2532,7 @@ ___ • **gasPrice**? : *undefined | string* -*Defined in [subproviders/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L86)* +*Defined in [subproviders/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L86)* ___ @@ -2497,7 +2540,7 @@ ___ • **nonce**: *string* -*Defined in [subproviders/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L85)* +*Defined in [subproviders/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L85)* ___ @@ -2505,7 +2548,7 @@ ___ • **to**: *string* -*Defined in [subproviders/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L88)* +*Defined in [subproviders/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L88)* ___ @@ -2513,7 +2556,7 @@ ___ • **value**? : *undefined | string* -*Defined in [subproviders/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L90)* +*Defined in [subproviders/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L90)*
@@ -2525,83 +2568,7 @@ ___ -# Class: EmptyWalletSubprovider -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It intercepts the `eth_accounts` JSON RPC requests and never returns any addresses when queried. - - -## 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/44793a9cf/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/empty_wallet_subprovider.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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 -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/44793a9cf/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* - -
@@ -2616,7 +2583,7 @@ Name | Type | Description | • **accountFetchingConfigs**: *[AccountFetchingConfigs](#class-accountfetchingconfigs)* -*Defined in [subproviders/src/types.ts:140](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L140)* +*Defined in [subproviders/src/types.ts:140](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L140)* ___ @@ -2624,7 +2591,7 @@ ___ • **networkId**: *number* -*Defined in [subproviders/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L142)* +*Defined in [subproviders/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L142)* ___ @@ -2632,7 +2599,7 @@ ___ • **trezorConnectClientApi**: *any* -*Defined in [subproviders/src/types.ts:141](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L141)* +*Defined in [subproviders/src/types.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L141)*
@@ -2661,8 +2628,6 @@ ___ - - @@ -2677,7 +2642,7 @@ Elliptic Curve signature • **r**: *string* -*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L62)* +*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L62)* ___ @@ -2685,7 +2650,7 @@ ___ • **s**: *string* -*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L63)* +*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L63)* ___ @@ -2693,7 +2658,7 @@ ___ • **v**: *number* -*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L61)* +*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L61)*
@@ -2713,7 +2678,7 @@ ___ • **name**: *string* -*Defined in [types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L732)* +*Defined in [types/src/index.ts:720](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L720)* ___ @@ -2721,7 +2686,7 @@ ___ • **type**: *string* -*Defined in [types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L733)* +*Defined in [types/src/index.ts:721](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L721)*
@@ -2734,7 +2699,7 @@ ___ • **domain**: *[EIP712Object](#class-eip712object)* -*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L748)* +*Defined in [types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L736)* ___ @@ -2742,7 +2707,7 @@ ___ • **message**: *[EIP712Object](#class-eip712object)* -*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L749)* +*Defined in [types/src/index.ts:737](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L737)* ___ @@ -2750,7 +2715,7 @@ ___ • **primaryType**: *string* -*Defined in [types/src/index.ts:750](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L750)* +*Defined in [types/src/index.ts:738](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L738)* ___ @@ -2758,7 +2723,7 @@ ___ • **types**: *[EIP712Types](#class-eip712types)* -*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L747)* +*Defined in [types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L735)*
@@ -2776,7 +2741,7 @@ ___ • **name**: *string* -*Defined in [types/src/index.ts:686](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L686)* +*Defined in [types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L674)* ___ @@ -2784,7 +2749,7 @@ ___ • **typeDocType**: *[TypeDocTypes](#enumeration-typedoctypes)* -*Defined in [types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/types/src/index.ts#L687)* +*Defined in [types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L675)*
@@ -2899,32 +2864,6 @@ ___ - - - - - - -## 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/44793a9cf/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* - -
@@ -2947,7 +2886,7 @@ Name | Type | Description | Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -2964,7 +2903,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -2993,7 +2932,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/44793a9cf/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -3008,7 +2947,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/44793a9cf/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)*
@@ -3021,7 +2960,7 @@ ___ ▸ **ledgerEthereumBrowserClientFactoryAsync**(): *`Promise`* -*Defined in [subproviders/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/index.ts#L11)* +*Defined in [subproviders/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/index.ts#L11)* A factory method for creating a LedgerEthereumClient usable in a browser context. @@ -3092,7 +3031,7 @@ LedgerEthereumClient A browser client for the LedgerSubprovider Ƭ **Callback**: *function* -*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L131)* +*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L131)* #### Type declaration: @@ -3106,7 +3045,7 @@ ___ Ƭ **ErrorCallback**: *function* -*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L130)* +*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L130)* #### Type declaration: @@ -3125,7 +3064,7 @@ ___ Ƭ **LedgerEthereumClientFactoryAsync**: *function* -*Defined in [subproviders/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L33)* +*Defined in [subproviders/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L33)* #### Type declaration: @@ -3137,7 +3076,7 @@ ___ Ƭ **NextCallback**: *function* -*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L133)* +*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L133)* #### Type declaration: @@ -3155,7 +3094,7 @@ ___ Ƭ **OnNextCompleted**: *function* -*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/subproviders/src/types.ts#L132)* +*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/subproviders/src/types.ts#L132)* #### Type declaration: @@ -3171,3 +3110,60 @@ 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/9fe6c196a/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:728](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L728)* + +___ + + + + + + + + + + + + + diff --git a/packages/tslint-config/CHANGELOG.json b/packages/tslint-config/CHANGELOG.json index def0632461..34ba702768 100644 --- a/packages/tslint-config/CHANGELOG.json +++ b/packages/tslint-config/CHANGELOG.json @@ -5,8 +5,7 @@ { "note": "Dependencies updated" } - ], - "timestamp": 1573001598 + ] }, { "version": "3.0.1", diff --git a/packages/tslint-config/CHANGELOG.md b/packages/tslint-config/CHANGELOG.md index 6dcd9a27e2..6d7c95b599 100644 --- a/packages/tslint-config/CHANGELOG.md +++ b/packages/tslint-config/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v3.1.0-beta.0 - _November 6, 2019_ - - * Dependencies updated - ## v3.0.1 - _April 11, 2019_ * Dependencies updated diff --git a/packages/types/CHANGELOG.json b/packages/types/CHANGELOG.json index a60250d6bb..5c9a0722f3 100644 --- a/packages/types/CHANGELOG.json +++ b/packages/types/CHANGELOG.json @@ -6,8 +6,7 @@ "note": "Add `SendTransactionOpts` and `AwaitTransactionSuccessOpts` types for contract wrappers", "pr": 2243 } - ], - "timestamp": 1573001598 + ] }, { "version": "2.5.0-beta.0", diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md index 8c68c4df4e..e4c1db6425 100644 --- a/packages/types/CHANGELOG.md +++ b/packages/types/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v2.5.0-beta.1 - _November 6, 2019_ - - * Add `SendTransactionOpts` and `AwaitTransactionSuccessOpts` types for contract wrappers (#2243) - ## v2.5.0-beta.0 - _October 3, 2019_ * Add `OrderStatus` type (#1761) diff --git a/packages/typescript-typings/CHANGELOG.json b/packages/typescript-typings/CHANGELOG.json index c138852489..f5c199d24b 100644 --- a/packages/typescript-typings/CHANGELOG.json +++ b/packages/typescript-typings/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "4.4.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "4.4.0-beta.0", "changes": [ diff --git a/packages/typescript-typings/CHANGELOG.md b/packages/typescript-typings/CHANGELOG.md index ce99d89083..d24bc819e5 100644 --- a/packages/typescript-typings/CHANGELOG.md +++ b/packages/typescript-typings/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v4.4.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v4.4.0-beta.0 - _October 3, 2019_ * Add types for `@0x/dev-utils` chai helpers in `types/@0x` (#1761) diff --git a/packages/utils/CHANGELOG.json b/packages/utils/CHANGELOG.json index 13ef2b52f5..769fd80687 100644 --- a/packages/utils/CHANGELOG.json +++ b/packages/utils/CHANGELOG.json @@ -10,8 +10,7 @@ "note": "Changed provider_utils.providerUtils.getChainIdAsync() to invoke RPC method eth_chainId rather than net_version", "pr": 2270 } - ], - "timestamp": 1573001598 + ] }, { "version": "4.6.0-beta.0", diff --git a/packages/utils/CHANGELOG.md b/packages/utils/CHANGELOG.md index 481ecc6d02..deed673b2c 100644 --- a/packages/utils/CHANGELOG.md +++ b/packages/utils/CHANGELOG.md @@ -5,11 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v4.6.0-beta.1 - _November 6, 2019_ - - * Consolidated FixedMathRevertErrors (#2255) - * Changed provider_utils.providerUtils.getChainIdAsync() to invoke RPC method eth_chainId rather than net_version (#2270) - ## v4.6.0-beta.0 - _October 3, 2019_ * Allow for array types in `RevertError`s. (#2075) diff --git a/packages/web3-wrapper/CHANGELOG.json b/packages/web3-wrapper/CHANGELOG.json index 19accabf51..427b1e2a74 100644 --- a/packages/web3-wrapper/CHANGELOG.json +++ b/packages/web3-wrapper/CHANGELOG.json @@ -1,13 +1,4 @@ [ - { - "version": "6.1.0-beta.1", - "changes": [ - { - "note": "Dependencies updated" - } - ], - "timestamp": 1573001598 - }, { "version": "6.1.0-beta.0", "changes": [ diff --git a/packages/web3-wrapper/CHANGELOG.md b/packages/web3-wrapper/CHANGELOG.md index 9b8a50b546..258eda180e 100644 --- a/packages/web3-wrapper/CHANGELOG.md +++ b/packages/web3-wrapper/CHANGELOG.md @@ -5,10 +5,6 @@ Edit the package's CHANGELOG.json file only. CHANGELOG -## v6.1.0-beta.1 - _November 6, 2019_ - - * Dependencies updated - ## v6.1.0-beta.0 - _October 3, 2019_ * Let `toBaseUnitAmount()` accept a `number` (#1819) diff --git a/packages/web3-wrapper/docs/reference.mdx b/packages/web3-wrapper/docs/reference.mdx index 2084540f7e..60eab6fac1 100644 --- a/packages/web3-wrapper/docs/reference.mdx +++ b/packages/web3-wrapper/docs/reference.mdx @@ -1,37 +1,95 @@ -# 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 +## Constructors -### `Optional` error -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L343)* +\+ **new AbiDecoder**(`abiArrays`: [AbiDefinition](#abidefinition)[][]): *[AbiDecoder](#class-abidecoder)* + +*Defined in [utils/src/abi_decoder.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/utils/src/abi_decoder.ts#L42)* + +Instantiate an AbiDecoder + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`abiArrays` | [AbiDefinition](#abidefinition)[][] | An array of contract ABI's | + +**Returns:** *[AbiDecoder](#class-abidecoder)* + +AbiDecoder instance + +## Methods + +### addABI + +▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void* + +*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/utils/src/abi_decoder.ts#L158)* + +Adds a set of ABI definitions, after which calldata and logs targeting these ABI's can be decoded. +Additional properties can be included to disambiguate similar ABI's. For example, if two functions +have the same signature but different parameter names, then their ABI definitions can be disambiguated +by specifying a contract name. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`abiArray` | [AbiDefinition](#abidefinition)[] | - | +`contractName?` | undefined \| string | Name of contract that encapsulates the ABI definitions (optional). This can be used when decoding calldata to disambiguate methods with the same signature but different parameter names. | + +**Returns:** *void* ___ -### id +### decodeCalldataOrThrow -• **id**: *number* +▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L341)* +*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/utils/src/abi_decoder.ts#L118)* + +Decodes calldata for a known ABI. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`calldata` | string | hex-encoded calldata. | +`contractName?` | undefined \| string | used to disambiguate similar ABI's (optional). | + +**Returns:** *`DecodedCalldata`* + +Decoded calldata. Includes: function name and signature, along with the decoded arguments. ___ -### jsonrpc +### tryToDecodeLogOrNoop -• **jsonrpc**: *string* +▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L342)* +*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/utils/src/abi_decoder.ts#L58)* -___ +Attempt to decode a log given the ABI's the AbiDecoder knows about. -### result +**Type parameters:** -• **result**: *any* +▪ **ArgsType**: *`DecodedLogArgs`* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L340)* +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`log` | `LogEntry` | The log to attempt to decode | + +**Returns:** *`LogWithDecodedArgs` | [RawLog](#rawlog)* + +The decoded log if the requisite ABI was available. Otherwise the log unaltered.
@@ -46,7 +104,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/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L144)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:144](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L144)* Instantiates a new Web3Wrapper. @@ -67,7 +125,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/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L54)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L54)* ___ @@ -75,7 +133,7 @@ ___ • **isZeroExWeb3Wrapper**: *boolean* = true -*Defined in [web3-wrapper/src/web3_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L53)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L53)* Flag to check if this instance is of type Web3Wrapper @@ -85,7 +143,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/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L576)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:576](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -111,7 +169,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/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L651)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -137,7 +195,7 @@ ___ ▸ **callAsync**(`callData`: `CallData`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:533](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L533)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:533](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L533)* Call a smart contract method at a given block height @@ -158,7 +216,7 @@ ___ ▸ **doesContractExistAtAddressAsync**(`address`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:281](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L281)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:281](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L281)* Check if a contract exists at a given address @@ -178,7 +236,7 @@ ___ ▸ **estimateGasAsync**(`txData`: `Partial`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:516](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L516)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:516](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L516)* Calculate the estimated gas cost for a given transaction @@ -198,7 +256,7 @@ ___ ▸ **getAvailableAddressesAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L429)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L429)* Retrieve the user addresses available through the backing provider @@ -212,7 +270,7 @@ ___ ▸ **getBalanceInWeiAsync**(`owner`: string, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:262](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L262)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:262](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L262)* Retrieves an accounts Ether balance in wei @@ -233,7 +291,7 @@ ___ ▸ **getBlockIfExistsAsync**(`blockParam`: string | [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:369](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L369)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:369](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L369)* Fetch a specific Ethereum block without transaction data @@ -254,7 +312,7 @@ ___ ▸ **getBlockNumberAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:355](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L355)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L355)* Fetches the latest block number @@ -268,7 +326,7 @@ ___ ▸ **getBlockTimestampAsync**(`blockParam`: string | [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L417)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L417)* Fetch a block's timestamp @@ -288,7 +346,7 @@ ___ ▸ **getBlockWithTransactionDataAsync**(`blockParam`: string | [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:395](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L395)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:395](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L395)* Fetch a specific Ethereum block with transaction data @@ -308,7 +366,7 @@ ___ ▸ **getChainIdAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:215](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L215)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L215)* Fetches the chainId of the backing Ethereum node @@ -322,7 +380,7 @@ ___ ▸ **getContractCodeAsync**(`address`: string, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:294](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L294)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:294](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L294)* Gets the contract code by address @@ -343,7 +401,7 @@ ___ ▸ **getContractDefaults**(): *`Partial` | undefined* -*Defined in [web3-wrapper/src/web3_wrapper.ts:163](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L163)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:163](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L163)* Get the contract defaults set to the Web3Wrapper instance @@ -357,7 +415,7 @@ ___ ▸ **getLogsAsync**(`filter`: `FilterObject`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:483](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L483)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L483)* Retrieve smart contract logs for a given filter @@ -377,7 +435,7 @@ ___ ▸ **getNetworkIdAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:206](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L206)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:206](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L206)* Fetches the networkId of the backing Ethereum node @@ -391,7 +449,7 @@ ___ ▸ **getNodeTypeAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:698](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L698)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:698](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -404,7 +462,7 @@ ___ ▸ **getNodeVersionAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:198](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L198)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:198](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L198)* Fetch the backing Ethereum node's version string (e.g `MetaMask/v4.2.0`) @@ -418,7 +476,7 @@ ___ ▸ **getProvider**(): *[SupportedProvider](#supportedprovider)* -*Defined in [web3-wrapper/src/web3_wrapper.ts:170](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L170)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:170](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L170)* Retrieve the Web3 provider @@ -432,7 +490,7 @@ ___ ▸ **getTransactionByHashAsync**(`txHash`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:247](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L247)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:247](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L247)* Retrieves the transaction data for a given transaction @@ -452,7 +510,7 @@ ___ ▸ **getTransactionReceiptIfExistsAsync**(`txHash`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:225](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L225)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:225](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L225)* Retrieves the transaction receipt for a given transaction hash if found @@ -472,7 +530,7 @@ ___ ▸ **getTransactionTraceAsync**(`txHash`: string, `traceParams`: `TraceParams`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L313)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L313)* Gets the debug trace of a transaction @@ -493,7 +551,7 @@ ___ ▸ **increaseTimeAsync**(`timeDelta`: number): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:466](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L466)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:466](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -512,7 +570,7 @@ ___ ▸ **isSenderAddressAvailableAsync**(`senderAddress`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:188](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L188)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:188](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -534,7 +592,7 @@ ___ ▸ **mineBlockAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:458](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L458)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:458](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L458)* Mine a block on a TestRPC/Ganache local node @@ -546,7 +604,7 @@ ___ ▸ **revertSnapshotAsync**(`snapshotId`: number): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:450](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L450)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:450](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L450)* Revert the blockchain state to a previous snapshot state on TestRPC/Ganache local node @@ -566,7 +624,7 @@ ___ ▸ **sendRawPayloadAsync**<**A**>(`payload`: `Partial`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:679](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L679)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:679](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L679)* Sends a raw Ethereum JSON RPC payload and returns the response's `result` key @@ -590,7 +648,7 @@ ___ ▸ **sendTransactionAsync**(`txData`: `TxData`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:555](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L555)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:555](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L555)* Send a transaction @@ -610,7 +668,7 @@ ___ ▸ **setHeadAsync**(`blockNumber`: number): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:670](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L670)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:670](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -632,7 +690,7 @@ ___ ▸ **setProvider**(`supportedProvider`: [SupportedProvider](#supportedprovider)): *void* -*Defined in [web3-wrapper/src/web3_wrapper.ts:177](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L177)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:177](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L177)* Update the used Web3 provider @@ -650,7 +708,7 @@ ___ ▸ **signMessageAsync**(`address`: string, `message`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:327](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L327)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:327](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L327)* Sign a message with a specific address's private key (`eth_sign`) @@ -671,7 +729,7 @@ ___ ▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:342](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L342)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L342)* Sign an EIP712 typed data message with a specific address's private key (`eth_signTypedData`) @@ -692,7 +750,7 @@ ___ ▸ **takeSnapshotAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:441](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L441)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:441](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L441)* Take a snapshot of the blockchain state on a TestRPC/Ganache local node @@ -706,7 +764,7 @@ ___ ▸ **isAddress**(`address`: string): *boolean* -*Defined in [web3-wrapper/src/web3_wrapper.ts:65](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L65)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:65](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L65)* Check if an address is a valid Ethereum address @@ -726,7 +784,7 @@ ___ ▸ **toBaseUnitAmount**(`amount`: `BigNumber` | number, `decimals`: number): *`BigNumber`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L91)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -749,7 +807,7 @@ ___ ▸ **toUnitAmount**(`amount`: `BigNumber`, `decimals`: number): *`BigNumber`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:76](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L76)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:76](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -772,7 +830,7 @@ ___ ▸ **toWei**(`ethAmount`: `BigNumber`): *`BigNumber`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:106](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/web3_wrapper.ts#L106)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:106](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/web3_wrapper.ts#L106)* Convert an Ether amount from ETH to Wei @@ -799,7 +857,7 @@ Amount in wei • **Earliest**: = "earliest" -*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L478)* +*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L478)* ___ @@ -807,7 +865,7 @@ ___ • **Latest**: = "latest" -*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L479)* +*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L479)* ___ @@ -815,7 +873,7 @@ ___ • **Pending**: = "pending" -*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L480)* +*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L480)*
@@ -828,7 +886,7 @@ ___ • **Add**: = "ADD" -*Defined in [ethereum-types/src/index.ts:147](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L147)* +*Defined in [ethereum-types/src/index.ts:147](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L147)* ___ @@ -836,7 +894,7 @@ ___ • **AddMod**: = "ADDMOD" -*Defined in [ethereum-types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L154)* +*Defined in [ethereum-types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L154)* ___ @@ -844,7 +902,7 @@ ___ • **Address**: = "ADDRESS" -*Defined in [ethereum-types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L173)* +*Defined in [ethereum-types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L173)* ___ @@ -852,7 +910,7 @@ ___ • **And**: = "AND" -*Defined in [ethereum-types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L165)* +*Defined in [ethereum-types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L165)* ___ @@ -860,7 +918,7 @@ ___ • **Balance**: = "BALANCE" -*Defined in [ethereum-types/src/index.ts:174](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L174)* +*Defined in [ethereum-types/src/index.ts:174](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L174)* ___ @@ -868,7 +926,7 @@ ___ • **BlockHash**: = "BLOCKHASH" -*Defined in [ethereum-types/src/index.ts:189](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L189)* +*Defined in [ethereum-types/src/index.ts:189](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L189)* ___ @@ -876,7 +934,7 @@ ___ • **Byte**: = "BYTE" -*Defined in [ethereum-types/src/index.ts:169](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L169)* +*Defined in [ethereum-types/src/index.ts:169](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L169)* ___ @@ -884,7 +942,7 @@ ___ • **Call**: = "CALL" -*Defined in [ethereum-types/src/index.ts:282](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L282)* +*Defined in [ethereum-types/src/index.ts:282](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L282)* ___ @@ -892,7 +950,7 @@ ___ • **CallCode**: = "CALLCODE" -*Defined in [ethereum-types/src/index.ts:283](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L283)* +*Defined in [ethereum-types/src/index.ts:283](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L283)* ___ @@ -900,7 +958,7 @@ ___ • **CallDataCopy**: = "CALLDATACOPY" -*Defined in [ethereum-types/src/index.ts:180](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L180)* +*Defined in [ethereum-types/src/index.ts:180](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L180)* ___ @@ -908,7 +966,7 @@ ___ • **CallDataLoad**: = "CALLDATALOAD" -*Defined in [ethereum-types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L178)* +*Defined in [ethereum-types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L178)* ___ @@ -916,7 +974,7 @@ ___ • **CallDataSize**: = "CALLDATASIZE" -*Defined in [ethereum-types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L179)* +*Defined in [ethereum-types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L179)* ___ @@ -924,7 +982,7 @@ ___ • **CallValue**: = "CALLVALUE" -*Defined in [ethereum-types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L177)* +*Defined in [ethereum-types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L177)* ___ @@ -932,7 +990,7 @@ ___ • **Caller**: = "CALLER" -*Defined in [ethereum-types/src/index.ts:176](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L176)* +*Defined in [ethereum-types/src/index.ts:176](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L176)* ___ @@ -940,7 +998,7 @@ ___ • **CodeCopy**: = "CODECOPY" -*Defined in [ethereum-types/src/index.ts:182](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L182)* +*Defined in [ethereum-types/src/index.ts:182](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L182)* ___ @@ -948,7 +1006,7 @@ ___ • **CodeSize**: = "CODESIZE" -*Defined in [ethereum-types/src/index.ts:181](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L181)* +*Defined in [ethereum-types/src/index.ts:181](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L181)* ___ @@ -956,7 +1014,7 @@ ___ • **Coinbase**: = "COINBASE" -*Defined in [ethereum-types/src/index.ts:190](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L190)* +*Defined in [ethereum-types/src/index.ts:190](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L190)* ___ @@ -964,7 +1022,7 @@ ___ • **Create**: = "CREATE" -*Defined in [ethereum-types/src/index.ts:281](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L281)* +*Defined in [ethereum-types/src/index.ts:281](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L281)* ___ @@ -972,7 +1030,7 @@ ___ • **DelegateCall**: = "DELEGATECALL" -*Defined in [ethereum-types/src/index.ts:285](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L285)* +*Defined in [ethereum-types/src/index.ts:285](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L285)* ___ @@ -980,7 +1038,7 @@ ___ • **Difficulty**: = "DIFFICULTY" -*Defined in [ethereum-types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L193)* +*Defined in [ethereum-types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L193)* ___ @@ -988,7 +1046,7 @@ ___ • **Div**: = "DIV" -*Defined in [ethereum-types/src/index.ts:150](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L150)* +*Defined in [ethereum-types/src/index.ts:150](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L150)* ___ @@ -996,7 +1054,7 @@ ___ • **Dup1**: = "DUP1" -*Defined in [ethereum-types/src/index.ts:242](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L242)* +*Defined in [ethereum-types/src/index.ts:242](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L242)* ___ @@ -1004,7 +1062,7 @@ ___ • **Dup10**: = "DUP10" -*Defined in [ethereum-types/src/index.ts:251](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L251)* +*Defined in [ethereum-types/src/index.ts:251](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L251)* ___ @@ -1012,7 +1070,7 @@ ___ • **Dup11**: = "DUP11" -*Defined in [ethereum-types/src/index.ts:252](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L252)* +*Defined in [ethereum-types/src/index.ts:252](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L252)* ___ @@ -1020,7 +1078,7 @@ ___ • **Dup12**: = "DUP12" -*Defined in [ethereum-types/src/index.ts:253](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L253)* +*Defined in [ethereum-types/src/index.ts:253](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L253)* ___ @@ -1028,7 +1086,7 @@ ___ • **Dup13**: = "DUP13" -*Defined in [ethereum-types/src/index.ts:254](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L254)* +*Defined in [ethereum-types/src/index.ts:254](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L254)* ___ @@ -1036,7 +1094,7 @@ ___ • **Dup14**: = "DUP14" -*Defined in [ethereum-types/src/index.ts:255](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L255)* +*Defined in [ethereum-types/src/index.ts:255](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L255)* ___ @@ -1044,7 +1102,7 @@ ___ • **Dup15**: = "DUP15" -*Defined in [ethereum-types/src/index.ts:256](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L256)* +*Defined in [ethereum-types/src/index.ts:256](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L256)* ___ @@ -1052,7 +1110,7 @@ ___ • **Dup16**: = "DUP16" -*Defined in [ethereum-types/src/index.ts:257](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L257)* +*Defined in [ethereum-types/src/index.ts:257](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L257)* ___ @@ -1060,7 +1118,7 @@ ___ • **Dup2**: = "DUP2" -*Defined in [ethereum-types/src/index.ts:243](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L243)* +*Defined in [ethereum-types/src/index.ts:243](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L243)* ___ @@ -1068,7 +1126,7 @@ ___ • **Dup3**: = "DUP3" -*Defined in [ethereum-types/src/index.ts:244](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L244)* +*Defined in [ethereum-types/src/index.ts:244](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L244)* ___ @@ -1076,7 +1134,7 @@ ___ • **Dup4**: = "DUP4" -*Defined in [ethereum-types/src/index.ts:245](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L245)* +*Defined in [ethereum-types/src/index.ts:245](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L245)* ___ @@ -1084,7 +1142,7 @@ ___ • **Dup5**: = "DUP5" -*Defined in [ethereum-types/src/index.ts:246](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L246)* +*Defined in [ethereum-types/src/index.ts:246](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L246)* ___ @@ -1092,7 +1150,7 @@ ___ • **Dup6**: = "DUP6" -*Defined in [ethereum-types/src/index.ts:247](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L247)* +*Defined in [ethereum-types/src/index.ts:247](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L247)* ___ @@ -1100,7 +1158,7 @@ ___ • **Dup7**: = "DUP7" -*Defined in [ethereum-types/src/index.ts:248](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L248)* +*Defined in [ethereum-types/src/index.ts:248](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L248)* ___ @@ -1108,7 +1166,7 @@ ___ • **Dup8**: = "DUP8" -*Defined in [ethereum-types/src/index.ts:249](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L249)* +*Defined in [ethereum-types/src/index.ts:249](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L249)* ___ @@ -1116,7 +1174,7 @@ ___ • **Dup9**: = "DUP9" -*Defined in [ethereum-types/src/index.ts:250](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L250)* +*Defined in [ethereum-types/src/index.ts:250](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L250)* ___ @@ -1124,7 +1182,7 @@ ___ • **Eq**: = "EQ" -*Defined in [ethereum-types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L163)* +*Defined in [ethereum-types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L163)* ___ @@ -1132,7 +1190,7 @@ ___ • **Exp**: = "EXP" -*Defined in [ethereum-types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L156)* +*Defined in [ethereum-types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L156)* ___ @@ -1140,7 +1198,7 @@ ___ • **ExtCodeCopy**: = "EXTCODECOPY" -*Defined in [ethereum-types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L185)* +*Defined in [ethereum-types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L185)* ___ @@ -1148,7 +1206,7 @@ ___ • **ExtCodeSize**: = "EXTCODESIZE" -*Defined in [ethereum-types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L184)* +*Defined in [ethereum-types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L184)* ___ @@ -1156,7 +1214,7 @@ ___ • **Gas**: = "GAS" -*Defined in [ethereum-types/src/index.ts:206](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L206)* +*Defined in [ethereum-types/src/index.ts:206](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L206)* ___ @@ -1164,7 +1222,7 @@ ___ • **GasPrice**: = "GASPRICE" -*Defined in [ethereum-types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L183)* +*Defined in [ethereum-types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L183)* ___ @@ -1172,7 +1230,7 @@ ___ • **Gaslimit**: = "GASLIMIT" -*Defined in [ethereum-types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L194)* +*Defined in [ethereum-types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L194)* ___ @@ -1180,7 +1238,7 @@ ___ • **Gt**: = "GT" -*Defined in [ethereum-types/src/index.ts:160](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L160)* +*Defined in [ethereum-types/src/index.ts:160](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L160)* ___ @@ -1188,7 +1246,7 @@ ___ • **Invalid**: = "INVALID" -*Defined in [ethereum-types/src/index.ts:288](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L288)* +*Defined in [ethereum-types/src/index.ts:288](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L288)* ___ @@ -1196,7 +1254,7 @@ ___ • **IsZero**: = "ISZERO" -*Defined in [ethereum-types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L164)* +*Defined in [ethereum-types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L164)* ___ @@ -1204,7 +1262,7 @@ ___ • **Jump**: = "JUMP" -*Defined in [ethereum-types/src/index.ts:202](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L202)* +*Defined in [ethereum-types/src/index.ts:202](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L202)* ___ @@ -1212,7 +1270,7 @@ ___ • **JumpDest**: = "JUMPDEST" -*Defined in [ethereum-types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L207)* +*Defined in [ethereum-types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L207)* ___ @@ -1220,7 +1278,7 @@ ___ • **Jumpi**: = "JUMPI" -*Defined in [ethereum-types/src/index.ts:203](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L203)* +*Defined in [ethereum-types/src/index.ts:203](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L203)* ___ @@ -1228,7 +1286,7 @@ ___ • **Log1**: = "LOG1" -*Defined in [ethereum-types/src/index.ts:276](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L276)* +*Defined in [ethereum-types/src/index.ts:276](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L276)* ___ @@ -1236,7 +1294,7 @@ ___ • **Log2**: = "LOG2" -*Defined in [ethereum-types/src/index.ts:277](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L277)* +*Defined in [ethereum-types/src/index.ts:277](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L277)* ___ @@ -1244,7 +1302,7 @@ ___ • **Log3**: = "LOG3" -*Defined in [ethereum-types/src/index.ts:278](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L278)* +*Defined in [ethereum-types/src/index.ts:278](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L278)* ___ @@ -1252,7 +1310,7 @@ ___ • **Log4**: = "LOG4" -*Defined in [ethereum-types/src/index.ts:279](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L279)* +*Defined in [ethereum-types/src/index.ts:279](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L279)* ___ @@ -1260,7 +1318,7 @@ ___ • **Lt**: = "LT" -*Defined in [ethereum-types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L159)* +*Defined in [ethereum-types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L159)* ___ @@ -1268,7 +1326,7 @@ ___ • **MLoad**: = "MLOAD" -*Defined in [ethereum-types/src/index.ts:197](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L197)* +*Defined in [ethereum-types/src/index.ts:197](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L197)* ___ @@ -1276,7 +1334,7 @@ ___ • **MSize**: = "MSIZE" -*Defined in [ethereum-types/src/index.ts:205](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L205)* +*Defined in [ethereum-types/src/index.ts:205](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L205)* ___ @@ -1284,7 +1342,7 @@ ___ • **MStore**: = "MSTORE" -*Defined in [ethereum-types/src/index.ts:198](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L198)* +*Defined in [ethereum-types/src/index.ts:198](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L198)* ___ @@ -1292,7 +1350,7 @@ ___ • **MStore8**: = "MSTORE8" -*Defined in [ethereum-types/src/index.ts:199](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L199)* +*Defined in [ethereum-types/src/index.ts:199](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L199)* ___ @@ -1300,7 +1358,7 @@ ___ • **Mod**: = "MOD" -*Defined in [ethereum-types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L152)* +*Defined in [ethereum-types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L152)* ___ @@ -1308,7 +1366,7 @@ ___ • **Mul**: = "MUL" -*Defined in [ethereum-types/src/index.ts:148](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L148)* +*Defined in [ethereum-types/src/index.ts:148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L148)* ___ @@ -1316,7 +1374,7 @@ ___ • **MulMod**: = "MULMOD" -*Defined in [ethereum-types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L155)* +*Defined in [ethereum-types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L155)* ___ @@ -1324,7 +1382,7 @@ ___ • **Not**: = "NOT" -*Defined in [ethereum-types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L168)* +*Defined in [ethereum-types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L168)* ___ @@ -1332,7 +1390,7 @@ ___ • **Number**: = "NUMBER" -*Defined in [ethereum-types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L192)* +*Defined in [ethereum-types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L192)* ___ @@ -1340,7 +1398,7 @@ ___ • **Or**: = "OR" -*Defined in [ethereum-types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L166)* +*Defined in [ethereum-types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L166)* ___ @@ -1348,7 +1406,7 @@ ___ • **Origin**: = "ORIGIN" -*Defined in [ethereum-types/src/index.ts:175](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L175)* +*Defined in [ethereum-types/src/index.ts:175](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L175)* ___ @@ -1356,7 +1414,7 @@ ___ • **Pc**: = "PC" -*Defined in [ethereum-types/src/index.ts:204](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L204)* +*Defined in [ethereum-types/src/index.ts:204](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L204)* ___ @@ -1364,7 +1422,7 @@ ___ • **Pop**: = "POP" -*Defined in [ethereum-types/src/index.ts:196](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L196)* +*Defined in [ethereum-types/src/index.ts:196](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L196)* ___ @@ -1372,7 +1430,7 @@ ___ • **Push1**: = "PUSH1" -*Defined in [ethereum-types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L209)* +*Defined in [ethereum-types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L209)* ___ @@ -1380,7 +1438,7 @@ ___ • **Push10**: = "PUSH10" -*Defined in [ethereum-types/src/index.ts:218](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L218)* +*Defined in [ethereum-types/src/index.ts:218](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L218)* ___ @@ -1388,7 +1446,7 @@ ___ • **Push11**: = "PUSH11" -*Defined in [ethereum-types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L219)* +*Defined in [ethereum-types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L219)* ___ @@ -1396,7 +1454,7 @@ ___ • **Push12**: = "PUSH12" -*Defined in [ethereum-types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L220)* +*Defined in [ethereum-types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L220)* ___ @@ -1404,7 +1462,7 @@ ___ • **Push13**: = "PUSH13" -*Defined in [ethereum-types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L221)* +*Defined in [ethereum-types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L221)* ___ @@ -1412,7 +1470,7 @@ ___ • **Push14**: = "PUSH14" -*Defined in [ethereum-types/src/index.ts:222](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L222)* +*Defined in [ethereum-types/src/index.ts:222](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L222)* ___ @@ -1420,7 +1478,7 @@ ___ • **Push15**: = "PUSH15" -*Defined in [ethereum-types/src/index.ts:223](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L223)* +*Defined in [ethereum-types/src/index.ts:223](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L223)* ___ @@ -1428,7 +1486,7 @@ ___ • **Push16**: = "PUSH16" -*Defined in [ethereum-types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L224)* +*Defined in [ethereum-types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L224)* ___ @@ -1436,7 +1494,7 @@ ___ • **Push17**: = "PUSH17" -*Defined in [ethereum-types/src/index.ts:225](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L225)* +*Defined in [ethereum-types/src/index.ts:225](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L225)* ___ @@ -1444,7 +1502,7 @@ ___ • **Push18**: = "PUSH18" -*Defined in [ethereum-types/src/index.ts:226](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L226)* +*Defined in [ethereum-types/src/index.ts:226](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L226)* ___ @@ -1452,7 +1510,7 @@ ___ • **Push19**: = "PUSH19" -*Defined in [ethereum-types/src/index.ts:227](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L227)* +*Defined in [ethereum-types/src/index.ts:227](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L227)* ___ @@ -1460,7 +1518,7 @@ ___ • **Push2**: = "PUSH2" -*Defined in [ethereum-types/src/index.ts:210](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L210)* +*Defined in [ethereum-types/src/index.ts:210](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L210)* ___ @@ -1468,7 +1526,7 @@ ___ • **Push20**: = "PUSH20" -*Defined in [ethereum-types/src/index.ts:228](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L228)* +*Defined in [ethereum-types/src/index.ts:228](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L228)* ___ @@ -1476,7 +1534,7 @@ ___ • **Push21**: = "PUSH21" -*Defined in [ethereum-types/src/index.ts:229](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L229)* +*Defined in [ethereum-types/src/index.ts:229](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L229)* ___ @@ -1484,7 +1542,7 @@ ___ • **Push22**: = "PUSH22" -*Defined in [ethereum-types/src/index.ts:230](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L230)* +*Defined in [ethereum-types/src/index.ts:230](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L230)* ___ @@ -1492,7 +1550,7 @@ ___ • **Push23**: = "PUSH23" -*Defined in [ethereum-types/src/index.ts:231](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L231)* +*Defined in [ethereum-types/src/index.ts:231](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L231)* ___ @@ -1500,7 +1558,7 @@ ___ • **Push24**: = "PUSH24" -*Defined in [ethereum-types/src/index.ts:232](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L232)* +*Defined in [ethereum-types/src/index.ts:232](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L232)* ___ @@ -1508,7 +1566,7 @@ ___ • **Push25**: = "PUSH25" -*Defined in [ethereum-types/src/index.ts:233](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L233)* +*Defined in [ethereum-types/src/index.ts:233](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L233)* ___ @@ -1516,7 +1574,7 @@ ___ • **Push26**: = "PUSH26" -*Defined in [ethereum-types/src/index.ts:234](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L234)* +*Defined in [ethereum-types/src/index.ts:234](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L234)* ___ @@ -1524,7 +1582,7 @@ ___ • **Push27**: = "PUSH27" -*Defined in [ethereum-types/src/index.ts:235](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L235)* +*Defined in [ethereum-types/src/index.ts:235](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L235)* ___ @@ -1532,7 +1590,7 @@ ___ • **Push28**: = "PUSH28" -*Defined in [ethereum-types/src/index.ts:236](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L236)* +*Defined in [ethereum-types/src/index.ts:236](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L236)* ___ @@ -1540,7 +1598,7 @@ ___ • **Push29**: = "PUSH29" -*Defined in [ethereum-types/src/index.ts:237](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L237)* +*Defined in [ethereum-types/src/index.ts:237](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L237)* ___ @@ -1548,7 +1606,7 @@ ___ • **Push3**: = "PUSH3" -*Defined in [ethereum-types/src/index.ts:211](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L211)* +*Defined in [ethereum-types/src/index.ts:211](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L211)* ___ @@ -1556,7 +1614,7 @@ ___ • **Push30**: = "PUSH30" -*Defined in [ethereum-types/src/index.ts:238](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L238)* +*Defined in [ethereum-types/src/index.ts:238](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L238)* ___ @@ -1564,7 +1622,7 @@ ___ • **Push31**: = "PUSH31" -*Defined in [ethereum-types/src/index.ts:239](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L239)* +*Defined in [ethereum-types/src/index.ts:239](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L239)* ___ @@ -1572,7 +1630,7 @@ ___ • **Push32**: = "PUSH32" -*Defined in [ethereum-types/src/index.ts:240](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L240)* +*Defined in [ethereum-types/src/index.ts:240](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L240)* ___ @@ -1580,7 +1638,7 @@ ___ • **Push4**: = "PUSH4" -*Defined in [ethereum-types/src/index.ts:212](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L212)* +*Defined in [ethereum-types/src/index.ts:212](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L212)* ___ @@ -1588,7 +1646,7 @@ ___ • **Push5**: = "PUSH5" -*Defined in [ethereum-types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L213)* +*Defined in [ethereum-types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L213)* ___ @@ -1596,7 +1654,7 @@ ___ • **Push6**: = "PUSH6" -*Defined in [ethereum-types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L214)* +*Defined in [ethereum-types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L214)* ___ @@ -1604,7 +1662,7 @@ ___ • **Push7**: = "PUSH7" -*Defined in [ethereum-types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L215)* +*Defined in [ethereum-types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L215)* ___ @@ -1612,7 +1670,7 @@ ___ • **Push8**: = "PUSH8" -*Defined in [ethereum-types/src/index.ts:216](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L216)* +*Defined in [ethereum-types/src/index.ts:216](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L216)* ___ @@ -1620,7 +1678,7 @@ ___ • **Push9**: = "PUSH9" -*Defined in [ethereum-types/src/index.ts:217](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L217)* +*Defined in [ethereum-types/src/index.ts:217](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L217)* ___ @@ -1628,7 +1686,7 @@ ___ • **Return**: = "RETURN" -*Defined in [ethereum-types/src/index.ts:284](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L284)* +*Defined in [ethereum-types/src/index.ts:284](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L284)* ___ @@ -1636,7 +1694,7 @@ ___ • **ReturnDataCopy**: = "RETURNDATACOPY" -*Defined in [ethereum-types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L187)* +*Defined in [ethereum-types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L187)* ___ @@ -1644,7 +1702,7 @@ ___ • **ReturnDataSize**: = "RETURNDATASIZE" -*Defined in [ethereum-types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L186)* +*Defined in [ethereum-types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L186)* ___ @@ -1652,7 +1710,7 @@ ___ • **Revert**: = "REVERT" -*Defined in [ethereum-types/src/index.ts:287](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L287)* +*Defined in [ethereum-types/src/index.ts:287](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L287)* ___ @@ -1660,7 +1718,7 @@ ___ • **SDiv**: = "SDIV" -*Defined in [ethereum-types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L151)* +*Defined in [ethereum-types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L151)* ___ @@ -1668,7 +1726,7 @@ ___ • **SGt**: = "SGT" -*Defined in [ethereum-types/src/index.ts:162](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L162)* +*Defined in [ethereum-types/src/index.ts:162](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L162)* ___ @@ -1676,7 +1734,7 @@ ___ • **SLoad**: = "SLOAD" -*Defined in [ethereum-types/src/index.ts:200](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L200)* +*Defined in [ethereum-types/src/index.ts:200](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L200)* ___ @@ -1684,7 +1742,7 @@ ___ • **SLt**: = "SLT" -*Defined in [ethereum-types/src/index.ts:161](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L161)* +*Defined in [ethereum-types/src/index.ts:161](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L161)* ___ @@ -1692,7 +1750,7 @@ ___ • **SMod**: = "SMOD" -*Defined in [ethereum-types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L153)* +*Defined in [ethereum-types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L153)* ___ @@ -1700,7 +1758,7 @@ ___ • **SStore**: = "SSTORE" -*Defined in [ethereum-types/src/index.ts:201](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L201)* +*Defined in [ethereum-types/src/index.ts:201](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L201)* ___ @@ -1708,7 +1766,7 @@ ___ • **SelfDestruct**: = "SELFDESTRUCT" -*Defined in [ethereum-types/src/index.ts:289](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L289)* +*Defined in [ethereum-types/src/index.ts:289](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L289)* ___ @@ -1716,7 +1774,7 @@ ___ • **Sha3**: = "SHA3" -*Defined in [ethereum-types/src/index.ts:171](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L171)* +*Defined in [ethereum-types/src/index.ts:171](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L171)* ___ @@ -1724,7 +1782,7 @@ ___ • **SignExtend**: = "SIGNEXTEND" -*Defined in [ethereum-types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L157)* +*Defined in [ethereum-types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L157)* ___ @@ -1732,7 +1790,7 @@ ___ • **StaticCall**: = "STATICCALL" -*Defined in [ethereum-types/src/index.ts:286](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L286)* +*Defined in [ethereum-types/src/index.ts:286](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L286)* ___ @@ -1740,7 +1798,7 @@ ___ • **Stop**: = "STOP" -*Defined in [ethereum-types/src/index.ts:146](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L146)* +*Defined in [ethereum-types/src/index.ts:146](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L146)* ___ @@ -1748,7 +1806,7 @@ ___ • **Sub**: = "SUB" -*Defined in [ethereum-types/src/index.ts:149](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L149)* +*Defined in [ethereum-types/src/index.ts:149](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L149)* ___ @@ -1756,7 +1814,7 @@ ___ • **Swap1**: = "SWAP1" -*Defined in [ethereum-types/src/index.ts:259](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L259)* +*Defined in [ethereum-types/src/index.ts:259](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L259)* ___ @@ -1764,7 +1822,7 @@ ___ • **Swap10**: = "SWAP10" -*Defined in [ethereum-types/src/index.ts:268](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L268)* +*Defined in [ethereum-types/src/index.ts:268](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L268)* ___ @@ -1772,7 +1830,7 @@ ___ • **Swap11**: = "SWAP11" -*Defined in [ethereum-types/src/index.ts:269](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L269)* +*Defined in [ethereum-types/src/index.ts:269](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L269)* ___ @@ -1780,7 +1838,7 @@ ___ • **Swap12**: = "SWAP12" -*Defined in [ethereum-types/src/index.ts:270](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L270)* +*Defined in [ethereum-types/src/index.ts:270](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L270)* ___ @@ -1788,7 +1846,7 @@ ___ • **Swap13**: = "SWAP13" -*Defined in [ethereum-types/src/index.ts:271](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L271)* +*Defined in [ethereum-types/src/index.ts:271](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L271)* ___ @@ -1796,7 +1854,7 @@ ___ • **Swap14**: = "SWAP14" -*Defined in [ethereum-types/src/index.ts:272](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L272)* +*Defined in [ethereum-types/src/index.ts:272](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L272)* ___ @@ -1804,7 +1862,7 @@ ___ • **Swap15**: = "SWAP15" -*Defined in [ethereum-types/src/index.ts:273](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L273)* +*Defined in [ethereum-types/src/index.ts:273](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L273)* ___ @@ -1812,7 +1870,7 @@ ___ • **Swap16**: = "SWAP16" -*Defined in [ethereum-types/src/index.ts:274](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L274)* +*Defined in [ethereum-types/src/index.ts:274](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L274)* ___ @@ -1820,7 +1878,7 @@ ___ • **Swap2**: = "SWAP2" -*Defined in [ethereum-types/src/index.ts:260](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L260)* +*Defined in [ethereum-types/src/index.ts:260](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L260)* ___ @@ -1828,7 +1886,7 @@ ___ • **Swap3**: = "SWAP3" -*Defined in [ethereum-types/src/index.ts:261](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L261)* +*Defined in [ethereum-types/src/index.ts:261](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L261)* ___ @@ -1836,7 +1894,7 @@ ___ • **Swap4**: = "SWAP4" -*Defined in [ethereum-types/src/index.ts:262](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L262)* +*Defined in [ethereum-types/src/index.ts:262](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L262)* ___ @@ -1844,7 +1902,7 @@ ___ • **Swap5**: = "SWAP5" -*Defined in [ethereum-types/src/index.ts:263](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L263)* +*Defined in [ethereum-types/src/index.ts:263](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L263)* ___ @@ -1852,7 +1910,7 @@ ___ • **Swap6**: = "SWAP6" -*Defined in [ethereum-types/src/index.ts:264](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L264)* +*Defined in [ethereum-types/src/index.ts:264](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L264)* ___ @@ -1860,7 +1918,7 @@ ___ • **Swap7**: = "SWAP7" -*Defined in [ethereum-types/src/index.ts:265](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L265)* +*Defined in [ethereum-types/src/index.ts:265](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L265)* ___ @@ -1868,7 +1926,7 @@ ___ • **Swap8**: = "SWAP8" -*Defined in [ethereum-types/src/index.ts:266](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L266)* +*Defined in [ethereum-types/src/index.ts:266](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L266)* ___ @@ -1876,7 +1934,7 @@ ___ • **Swap9**: = "SWAP9" -*Defined in [ethereum-types/src/index.ts:267](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L267)* +*Defined in [ethereum-types/src/index.ts:267](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L267)* ___ @@ -1884,7 +1942,7 @@ ___ • **TimeStamp**: = "TimeStamp" -*Defined in [ethereum-types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L191)* +*Defined in [ethereum-types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L191)* ___ @@ -1892,7 +1950,7 @@ ___ • **Xor**: = "XOR" -*Defined in [ethereum-types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L167)* +*Defined in [ethereum-types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L167)*
@@ -1907,7 +1965,7 @@ ___ • **Ganache**: = "GANACHE" -*Defined in [web3-wrapper/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L91)* +*Defined in [web3-wrapper/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L91)* ___ @@ -1915,7 +1973,7 @@ ___ • **Geth**: = "GETH" -*Defined in [web3-wrapper/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L90)* +*Defined in [web3-wrapper/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L90)*
@@ -1928,16 +1986,12 @@ ___ • **TransactionMiningTimeout**: = "TRANSACTION_MINING_TIMEOUT" -*Defined in [web3-wrapper/src/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L2)* +*Defined in [web3-wrapper/src/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L2)*
-
- - - # Interface: BlockWithoutTransactionData @@ -1951,7 +2005,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[difficulty](#difficulty)* -*Defined in [ethereum-types/src/index.ts:356](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L356)* +*Defined in [ethereum-types/src/index.ts:356](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L356)* ___ @@ -1961,7 +2015,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[extraData](#extradata)* -*Defined in [ethereum-types/src/index.ts:358](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L358)* +*Defined in [ethereum-types/src/index.ts:358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L358)* ___ @@ -1971,7 +2025,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasLimit](#gaslimit)* -*Defined in [ethereum-types/src/index.ts:360](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L360)* +*Defined in [ethereum-types/src/index.ts:360](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L360)* ___ @@ -1981,7 +2035,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasUsed](#gasused)* -*Defined in [ethereum-types/src/index.ts:361](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L361)* +*Defined in [ethereum-types/src/index.ts:361](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L361)* ___ @@ -1991,7 +2045,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[hash](#hash)* -*Defined in [ethereum-types/src/index.ts:348](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L348)* +*Defined in [ethereum-types/src/index.ts:348](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L348)* ___ @@ -2001,7 +2055,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[logsBloom](#logsbloom)* -*Defined in [ethereum-types/src/index.ts:352](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L352)* +*Defined in [ethereum-types/src/index.ts:352](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L352)* ___ @@ -2011,7 +2065,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[miner](#miner)* -*Defined in [ethereum-types/src/index.ts:355](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L355)* +*Defined in [ethereum-types/src/index.ts:355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L355)* ___ @@ -2021,7 +2075,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[nonce](#nonce)* -*Defined in [ethereum-types/src/index.ts:350](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L350)* +*Defined in [ethereum-types/src/index.ts:350](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L350)* ___ @@ -2031,7 +2085,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[number](#number)* -*Defined in [ethereum-types/src/index.ts:347](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L347)* +*Defined in [ethereum-types/src/index.ts:347](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L347)* ___ @@ -2041,7 +2095,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[parentHash](#parenthash)* -*Defined in [ethereum-types/src/index.ts:349](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L349)* +*Defined in [ethereum-types/src/index.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L349)* ___ @@ -2051,7 +2105,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[sha3Uncles](#sha3uncles)* -*Defined in [ethereum-types/src/index.ts:351](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L351)* +*Defined in [ethereum-types/src/index.ts:351](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L351)* ___ @@ -2061,7 +2115,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[size](#size)* -*Defined in [ethereum-types/src/index.ts:359](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L359)* +*Defined in [ethereum-types/src/index.ts:359](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L359)* ___ @@ -2071,7 +2125,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[stateRoot](#stateroot)* -*Defined in [ethereum-types/src/index.ts:354](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L354)* +*Defined in [ethereum-types/src/index.ts:354](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L354)* ___ @@ -2081,7 +2135,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[timestamp](#timestamp)* -*Defined in [ethereum-types/src/index.ts:362](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L362)* +*Defined in [ethereum-types/src/index.ts:362](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L362)* ___ @@ -2091,7 +2145,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[totalDifficulty](#totaldifficulty)* -*Defined in [ethereum-types/src/index.ts:357](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L357)* +*Defined in [ethereum-types/src/index.ts:357](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L357)* ___ @@ -2099,7 +2153,7 @@ ___ • **transactions**: *string[]* -*Defined in [ethereum-types/src/index.ts:367](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L367)* +*Defined in [ethereum-types/src/index.ts:367](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L367)* ___ @@ -2109,7 +2163,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[transactionsRoot](#transactionsroot)* -*Defined in [ethereum-types/src/index.ts:353](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L353)* +*Defined in [ethereum-types/src/index.ts:353](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L353)* ___ @@ -2119,7 +2173,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[uncles](#uncles)* -*Defined in [ethereum-types/src/index.ts:363](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L363)* +*Defined in [ethereum-types/src/index.ts:363](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L363)*
@@ -2134,7 +2188,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[difficulty](#difficulty)* -*Defined in [ethereum-types/src/index.ts:356](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L356)* +*Defined in [ethereum-types/src/index.ts:356](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L356)* ___ @@ -2144,7 +2198,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[extraData](#extradata)* -*Defined in [ethereum-types/src/index.ts:358](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L358)* +*Defined in [ethereum-types/src/index.ts:358](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L358)* ___ @@ -2154,7 +2208,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasLimit](#gaslimit)* -*Defined in [ethereum-types/src/index.ts:360](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L360)* +*Defined in [ethereum-types/src/index.ts:360](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L360)* ___ @@ -2164,7 +2218,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasUsed](#gasused)* -*Defined in [ethereum-types/src/index.ts:361](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L361)* +*Defined in [ethereum-types/src/index.ts:361](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L361)* ___ @@ -2174,7 +2228,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[hash](#hash)* -*Defined in [ethereum-types/src/index.ts:348](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L348)* +*Defined in [ethereum-types/src/index.ts:348](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L348)* ___ @@ -2184,7 +2238,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[logsBloom](#logsbloom)* -*Defined in [ethereum-types/src/index.ts:352](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L352)* +*Defined in [ethereum-types/src/index.ts:352](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L352)* ___ @@ -2194,7 +2248,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[miner](#miner)* -*Defined in [ethereum-types/src/index.ts:355](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L355)* +*Defined in [ethereum-types/src/index.ts:355](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L355)* ___ @@ -2204,7 +2258,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[nonce](#nonce)* -*Defined in [ethereum-types/src/index.ts:350](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L350)* +*Defined in [ethereum-types/src/index.ts:350](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L350)* ___ @@ -2214,7 +2268,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[number](#number)* -*Defined in [ethereum-types/src/index.ts:347](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L347)* +*Defined in [ethereum-types/src/index.ts:347](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L347)* ___ @@ -2224,7 +2278,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[parentHash](#parenthash)* -*Defined in [ethereum-types/src/index.ts:349](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L349)* +*Defined in [ethereum-types/src/index.ts:349](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L349)* ___ @@ -2234,7 +2288,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[sha3Uncles](#sha3uncles)* -*Defined in [ethereum-types/src/index.ts:351](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L351)* +*Defined in [ethereum-types/src/index.ts:351](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L351)* ___ @@ -2244,7 +2298,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[size](#size)* -*Defined in [ethereum-types/src/index.ts:359](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L359)* +*Defined in [ethereum-types/src/index.ts:359](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L359)* ___ @@ -2254,7 +2308,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[stateRoot](#stateroot)* -*Defined in [ethereum-types/src/index.ts:354](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L354)* +*Defined in [ethereum-types/src/index.ts:354](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L354)* ___ @@ -2264,7 +2318,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[timestamp](#timestamp)* -*Defined in [ethereum-types/src/index.ts:362](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L362)* +*Defined in [ethereum-types/src/index.ts:362](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L362)* ___ @@ -2274,7 +2328,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[totalDifficulty](#totaldifficulty)* -*Defined in [ethereum-types/src/index.ts:357](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L357)* +*Defined in [ethereum-types/src/index.ts:357](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L357)* ___ @@ -2282,7 +2336,7 @@ ___ • **transactions**: *[Transaction](#class-transaction)[]* -*Defined in [ethereum-types/src/index.ts:371](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L371)* +*Defined in [ethereum-types/src/index.ts:371](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L371)* ___ @@ -2292,7 +2346,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[transactionsRoot](#transactionsroot)* -*Defined in [ethereum-types/src/index.ts:353](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L353)* +*Defined in [ethereum-types/src/index.ts:353](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L353)* ___ @@ -2302,7 +2356,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[uncles](#uncles)* -*Defined in [ethereum-types/src/index.ts:363](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L363)* +*Defined in [ethereum-types/src/index.ts:363](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L363)*
@@ -2317,7 +2371,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -2325,7 +2379,7 @@ ___ • **from**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L402)* +*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L402)* ___ @@ -2335,7 +2389,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -2345,7 +2399,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -2355,7 +2409,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -2365,7 +2419,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -2375,7 +2429,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
@@ -2398,7 +2452,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L103)* +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L103)* ___ @@ -2406,7 +2460,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L104)* +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L104)* ___ @@ -2414,7 +2468,7 @@ ___ • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L105)* +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L105)* ___ @@ -2422,7 +2476,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L102)* +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L102)*
@@ -2441,7 +2495,7 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* ___ @@ -2449,7 +2503,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2457,7 +2511,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -2477,7 +2531,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2485,7 +2539,7 @@ ___ • **args**: *`A`* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* ___ @@ -2495,7 +2549,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -2505,7 +2559,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2515,7 +2569,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2523,7 +2577,7 @@ ___ • **event**: *string* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* ___ @@ -2533,7 +2587,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -2543,7 +2597,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -2553,7 +2607,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -2563,7 +2617,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -2582,7 +2636,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2592,7 +2646,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* ___ @@ -2602,7 +2656,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -2612,7 +2666,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2622,7 +2676,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2632,7 +2686,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* ___ @@ -2642,7 +2696,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -2650,7 +2704,7 @@ ___ • **removed**: *boolean* -*Defined in [ethereum-types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L421)* +*Defined in [ethereum-types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L421)* ___ @@ -2660,7 +2714,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -2670,7 +2724,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -2680,7 +2734,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -2695,7 +2749,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -2703,7 +2757,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -2727,7 +2781,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -2749,7 +2803,7 @@ Name | Type | • **anonymous**: *boolean* -*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L131)* +*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L131)* ___ @@ -2757,7 +2811,7 @@ ___ • **inputs**: *[EventParameter](#class-eventparameter)[]* -*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L130)* +*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L130)* ___ @@ -2765,7 +2819,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L129)* +*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L129)* ___ @@ -2773,7 +2827,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L128)* +*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L128)*
@@ -2788,7 +2842,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* ___ @@ -2796,7 +2850,7 @@ ___ • **indexed**: *boolean* -*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L116)* +*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L116)* ___ @@ -2806,7 +2860,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2816,7 +2870,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -2833,7 +2887,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L112)* +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L112)* ___ @@ -2841,7 +2895,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L111)* +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L111)*
@@ -2854,7 +2908,7 @@ ___ • **address**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:409](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L409)* +*Defined in [ethereum-types/src/index.ts:409](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L409)* ___ @@ -2862,7 +2916,7 @@ ___ • **blockHash**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L408)* +*Defined in [ethereum-types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L408)* ___ @@ -2870,7 +2924,7 @@ ___ • **fromBlock**? : *number | string* -*Defined in [ethereum-types/src/index.ts:406](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L406)* +*Defined in [ethereum-types/src/index.ts:406](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L406)* ___ @@ -2878,7 +2932,7 @@ ___ • **toBlock**? : *number | string* -*Defined in [ethereum-types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L407)* +*Defined in [ethereum-types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L407)* ___ @@ -2886,7 +2940,7 @@ ___ • **topics**? : *[LogTopic](#logtopic)[]* -*Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L410)* +*Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L410)*
@@ -2899,7 +2953,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/44793a9cf/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -2923,7 +2977,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* ___ @@ -2931,7 +2985,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* ___ @@ -2939,7 +2993,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* ___ @@ -2947,7 +3001,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)*
@@ -2960,7 +3014,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* ___ @@ -2968,102 +3022,44 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)*
-# 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. +# Interface: JSONRPCResponsePayload -## Constructors +## Properties +### `Optional` error +• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -\+ **new AbiDecoder**(`abiArrays`: [AbiDefinition](#abidefinition)[][]): *[AbiDecoder](#class-abidecoder)* - -*Defined in [utils/src/abi_decoder.ts:42](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/utils/src/abi_decoder.ts#L42)* - -Instantiate an AbiDecoder - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`abiArrays` | [AbiDefinition](#abidefinition)[][] | An array of contract ABI's | - -**Returns:** *[AbiDecoder](#class-abidecoder)* - -AbiDecoder instance - -## Methods - -### addABI - -▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void* - -*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/utils/src/abi_decoder.ts#L158)* - -Adds a set of ABI definitions, after which calldata and logs targeting these ABI's can be decoded. -Additional properties can be included to disambiguate similar ABI's. For example, if two functions -have the same signature but different parameter names, then their ABI definitions can be disambiguated -by specifying a contract name. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`abiArray` | [AbiDefinition](#abidefinition)[] | - | -`contractName?` | undefined \| string | Name of contract that encapsulates the ABI definitions (optional). This can be used when decoding calldata to disambiguate methods with the same signature but different parameter names. | - -**Returns:** *void* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* ___ -### decodeCalldataOrThrow +### id -▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* +• **id**: *number* -*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/utils/src/abi_decoder.ts#L118)* - -Decodes calldata for a known ABI. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`calldata` | string | hex-encoded calldata. | -`contractName?` | undefined \| string | used to disambiguate similar ABI's (optional). | - -**Returns:** *`DecodedCalldata`* - -Decoded calldata. Includes: function name and signature, along with the decoded arguments. +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* ___ -### tryToDecodeLogOrNoop +### jsonrpc -▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* +• **jsonrpc**: *string* -*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/utils/src/abi_decoder.ts#L58)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* -Attempt to decode a log given the ABI's the AbiDecoder knows about. +___ -**Type parameters:** +### result -▪ **ArgsType**: *`DecodedLogArgs`* +• **result**: *any* -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`log` | `LogEntry` | The log to attempt to decode | - -**Returns:** *`LogWithDecodedArgs` | [RawLog](#rawlog)* - -The decoded log if the requisite ABI was available. Otherwise the log unaltered. +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
@@ -3076,7 +3072,7 @@ The decoded log if the requisite ABI was available. Otherwise the log unaltered. • **address**: *string* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3084,7 +3080,7 @@ ___ • **blockHash**: *string | null* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3092,7 +3088,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3100,7 +3096,7 @@ ___ • **data**: *string* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3108,7 +3104,7 @@ ___ • **logIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -3116,7 +3112,7 @@ ___ • **topics**: *string[]* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3124,7 +3120,7 @@ ___ • **transactionHash**: *string* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -3132,7 +3128,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -3147,7 +3143,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3157,7 +3153,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3167,7 +3163,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3177,7 +3173,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3187,7 +3183,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -3195,7 +3191,7 @@ ___ • **removed**: *boolean* -*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L425)* +*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L425)* ___ @@ -3205,7 +3201,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3215,7 +3211,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -3225,7 +3221,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -3244,7 +3240,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3254,7 +3250,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* ___ @@ -3264,7 +3260,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3274,7 +3270,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3284,7 +3280,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3294,7 +3290,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* ___ @@ -3304,7 +3300,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -3314,7 +3310,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3324,7 +3320,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -3334,7 +3330,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -3347,7 +3343,7 @@ ___ • **constant**: *boolean* -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L94)* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L94)* ___ @@ -3355,7 +3351,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L92)* +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L92)* ___ @@ -3363,7 +3359,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L91)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L91)* ___ @@ -3371,7 +3367,7 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L93)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L93)* ___ @@ -3379,7 +3375,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L96)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L96)* ___ @@ -3387,7 +3383,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L95)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L95)* ___ @@ -3395,7 +3391,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L90)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L90)*
@@ -3412,7 +3408,7 @@ ___ • **address**: *string* -*Defined in [ethereum-types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L491)* +*Defined in [ethereum-types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L491)* ___ @@ -3420,7 +3416,7 @@ ___ • **blockHash**: *string | null* -*Defined in [ethereum-types/src/index.ts:489](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L489)* +*Defined in [ethereum-types/src/index.ts:489](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L489)* ___ @@ -3428,7 +3424,7 @@ ___ • **blockNumber**: *string | null* -*Defined in [ethereum-types/src/index.ts:490](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L490)* +*Defined in [ethereum-types/src/index.ts:490](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L490)* ___ @@ -3436,7 +3432,7 @@ ___ • **data**: *string* -*Defined in [ethereum-types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L492)* +*Defined in [ethereum-types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L492)* ___ @@ -3444,7 +3440,7 @@ ___ • **logIndex**: *string | null* -*Defined in [ethereum-types/src/index.ts:486](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L486)* +*Defined in [ethereum-types/src/index.ts:486](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L486)* ___ @@ -3452,7 +3448,7 @@ ___ • **topics**: *string[]* -*Defined in [ethereum-types/src/index.ts:493](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L493)* +*Defined in [ethereum-types/src/index.ts:493](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L493)* ___ @@ -3460,7 +3456,7 @@ ___ • **transactionHash**: *string* -*Defined in [ethereum-types/src/index.ts:488](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L488)* +*Defined in [ethereum-types/src/index.ts:488](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L488)* ___ @@ -3468,7 +3464,7 @@ ___ • **transactionIndex**: *string | null* -*Defined in [ethereum-types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L487)* +*Defined in [ethereum-types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L487)*
@@ -3481,7 +3477,7 @@ ___ • **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L122)* +*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L122)* ___ @@ -3489,7 +3485,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L121)* +*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L121)* ___ @@ -3497,7 +3493,7 @@ ___ • **type**: *"error"* -*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L120)* +*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L120)*
@@ -3520,7 +3516,7 @@ ___ • **depth**: *number* -*Defined in [ethereum-types/src/index.ts:293](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L293)* +*Defined in [ethereum-types/src/index.ts:293](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L293)* ___ @@ -3528,7 +3524,7 @@ ___ • **error**: *string* -*Defined in [ethereum-types/src/index.ts:294](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L294)* +*Defined in [ethereum-types/src/index.ts:294](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L294)* ___ @@ -3536,7 +3532,7 @@ ___ • **gas**: *number* -*Defined in [ethereum-types/src/index.ts:295](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L295)* +*Defined in [ethereum-types/src/index.ts:295](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L295)* ___ @@ -3544,7 +3540,7 @@ ___ • **gasCost**: *number* -*Defined in [ethereum-types/src/index.ts:296](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L296)* +*Defined in [ethereum-types/src/index.ts:296](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L296)* ___ @@ -3552,7 +3548,7 @@ ___ • **memory**: *string[]* -*Defined in [ethereum-types/src/index.ts:297](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L297)* +*Defined in [ethereum-types/src/index.ts:297](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L297)* ___ @@ -3560,7 +3556,7 @@ ___ • **op**: *[OpCode](#enumeration-opcode)* -*Defined in [ethereum-types/src/index.ts:298](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L298)* +*Defined in [ethereum-types/src/index.ts:298](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L298)* ___ @@ -3568,7 +3564,7 @@ ___ • **pc**: *number* -*Defined in [ethereum-types/src/index.ts:299](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L299)* +*Defined in [ethereum-types/src/index.ts:299](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L299)* ___ @@ -3576,7 +3572,7 @@ ___ • **stack**: *string[]* -*Defined in [ethereum-types/src/index.ts:300](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L300)* +*Defined in [ethereum-types/src/index.ts:300](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L300)* ___ @@ -3584,7 +3580,7 @@ ___ • **storage**: *object* -*Defined in [ethereum-types/src/index.ts:301](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L301)* +*Defined in [ethereum-types/src/index.ts:301](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L301)* #### Type declaration: @@ -3601,7 +3597,7 @@ ___ • **disableMemory**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:518](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L518)* +*Defined in [ethereum-types/src/index.ts:518](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L518)* ___ @@ -3609,7 +3605,7 @@ ___ • **disableStack**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:519](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L519)* +*Defined in [ethereum-types/src/index.ts:519](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L519)* ___ @@ -3617,7 +3613,7 @@ ___ • **disableStorage**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:520](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L520)* +*Defined in [ethereum-types/src/index.ts:520](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L520)* ___ @@ -3625,7 +3621,7 @@ ___ • **timeout**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:522](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L522)* +*Defined in [ethereum-types/src/index.ts:522](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L522)* ___ @@ -3633,7 +3629,7 @@ ___ • **tracer**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:521](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L521)* +*Defined in [ethereum-types/src/index.ts:521](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L521)*
@@ -3646,7 +3642,7 @@ ___ • **blockHash**: *string | null* -*Defined in [ethereum-types/src/index.ts:377](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L377)* +*Defined in [ethereum-types/src/index.ts:377](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L377)* ___ @@ -3654,7 +3650,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [ethereum-types/src/index.ts:378](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L378)* +*Defined in [ethereum-types/src/index.ts:378](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L378)* ___ @@ -3662,7 +3658,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:380](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L380)* +*Defined in [ethereum-types/src/index.ts:380](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L380)* ___ @@ -3670,7 +3666,7 @@ ___ • **gas**: *number* -*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L384)* +*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L384)* ___ @@ -3678,7 +3674,7 @@ ___ • **gasPrice**: *`BigNumber`* -*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L383)* +*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L383)* ___ @@ -3686,7 +3682,7 @@ ___ • **hash**: *string* -*Defined in [ethereum-types/src/index.ts:375](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L375)* +*Defined in [ethereum-types/src/index.ts:375](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L375)* ___ @@ -3694,7 +3690,7 @@ ___ • **input**: *string* -*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L385)* +*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L385)* ___ @@ -3702,7 +3698,7 @@ ___ • **nonce**: *number* -*Defined in [ethereum-types/src/index.ts:376](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L376)* +*Defined in [ethereum-types/src/index.ts:376](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L376)* ___ @@ -3710,7 +3706,7 @@ ___ • **to**: *string | null* -*Defined in [ethereum-types/src/index.ts:381](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L381)* +*Defined in [ethereum-types/src/index.ts:381](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L381)* ___ @@ -3718,7 +3714,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:379](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L379)* +*Defined in [ethereum-types/src/index.ts:379](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L379)* ___ @@ -3726,7 +3722,7 @@ ___ • **value**: *`BigNumber`* -*Defined in [ethereum-types/src/index.ts:382](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L382)* +*Defined in [ethereum-types/src/index.ts:382](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L382)*
@@ -3739,7 +3735,7 @@ ___ • **blockHash**: *string* -*Defined in [ethereum-types/src/index.ts:448](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L448)* +*Defined in [ethereum-types/src/index.ts:448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L448)* ___ @@ -3747,7 +3743,7 @@ ___ • **blockNumber**: *number* -*Defined in [ethereum-types/src/index.ts:449](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L449)* +*Defined in [ethereum-types/src/index.ts:449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L449)* ___ @@ -3755,7 +3751,7 @@ ___ • **contractAddress**: *string | null* -*Defined in [ethereum-types/src/index.ts:457](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L457)* +*Defined in [ethereum-types/src/index.ts:457](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L457)* ___ @@ -3763,7 +3759,7 @@ ___ • **cumulativeGasUsed**: *number* -*Defined in [ethereum-types/src/index.ts:455](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L455)* +*Defined in [ethereum-types/src/index.ts:455](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L455)* ___ @@ -3771,7 +3767,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L452)* +*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L452)* ___ @@ -3779,7 +3775,7 @@ ___ • **gasUsed**: *number* -*Defined in [ethereum-types/src/index.ts:456](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L456)* +*Defined in [ethereum-types/src/index.ts:456](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L456)* ___ @@ -3787,7 +3783,7 @@ ___ • **logs**: *[LogEntry](#class-logentry)[]* -*Defined in [ethereum-types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L458)* +*Defined in [ethereum-types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L458)* ___ @@ -3795,7 +3791,7 @@ ___ • **status**: *[TransactionReceiptStatus](#transactionreceiptstatus)* -*Defined in [ethereum-types/src/index.ts:454](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L454)* +*Defined in [ethereum-types/src/index.ts:454](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L454)* ___ @@ -3803,7 +3799,7 @@ ___ • **to**: *string* -*Defined in [ethereum-types/src/index.ts:453](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L453)* +*Defined in [ethereum-types/src/index.ts:453](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L453)* ___ @@ -3811,7 +3807,7 @@ ___ • **transactionHash**: *string* -*Defined in [ethereum-types/src/index.ts:450](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L450)* +*Defined in [ethereum-types/src/index.ts:450](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L450)* ___ @@ -3819,7 +3815,7 @@ ___ • **transactionIndex**: *number* -*Defined in [ethereum-types/src/index.ts:451](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L451)* +*Defined in [ethereum-types/src/index.ts:451](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L451)*
@@ -3838,7 +3834,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/44793a9cf/packages/ethereum-types/src/index.ts#L448)* +*Defined in [ethereum-types/src/index.ts:448](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L448)* ___ @@ -3848,7 +3844,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:449](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L449)* +*Defined in [ethereum-types/src/index.ts:449](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L449)* ___ @@ -3858,7 +3854,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[contractAddress](#contractaddress)* -*Defined in [ethereum-types/src/index.ts:457](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L457)* +*Defined in [ethereum-types/src/index.ts:457](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L457)* ___ @@ -3868,7 +3864,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[cumulativeGasUsed](#cumulativegasused)* -*Defined in [ethereum-types/src/index.ts:455](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L455)* +*Defined in [ethereum-types/src/index.ts:455](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L455)* ___ @@ -3878,7 +3874,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[from](#from)* -*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L452)* +*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L452)* ___ @@ -3888,7 +3884,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[gasUsed](#gasused)* -*Defined in [ethereum-types/src/index.ts:456](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L456)* +*Defined in [ethereum-types/src/index.ts:456](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L456)* ___ @@ -3898,7 +3894,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/44793a9cf/packages/ethereum-types/src/index.ts#L514)* +*Defined in [ethereum-types/src/index.ts:514](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L514)* ___ @@ -3908,7 +3904,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[status](#status)* -*Defined in [ethereum-types/src/index.ts:454](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L454)* +*Defined in [ethereum-types/src/index.ts:454](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L454)* ___ @@ -3918,7 +3914,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[to](#to)* -*Defined in [ethereum-types/src/index.ts:453](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L453)* +*Defined in [ethereum-types/src/index.ts:453](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L453)* ___ @@ -3928,7 +3924,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:450](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L450)* +*Defined in [ethereum-types/src/index.ts:450](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L450)* ___ @@ -3938,7 +3934,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:451](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L451)* +*Defined in [ethereum-types/src/index.ts:451](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L451)*
@@ -3951,7 +3947,7 @@ ___ • **gas**: *number* -*Defined in [ethereum-types/src/index.ts:305](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L305)* +*Defined in [ethereum-types/src/index.ts:305](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L305)* ___ @@ -3959,7 +3955,7 @@ ___ • **returnValue**: *any* -*Defined in [ethereum-types/src/index.ts:306](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L306)* +*Defined in [ethereum-types/src/index.ts:306](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L306)* ___ @@ -3967,7 +3963,7 @@ ___ • **structLogs**: *[StructLog](#class-structlog)[]* -*Defined in [ethereum-types/src/index.ts:307](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L307)* +*Defined in [ethereum-types/src/index.ts:307](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L307)*
@@ -3982,7 +3978,7 @@ ___ *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/44793a9cf/packages/ethereum-types/src/index.ts#L141)* +*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L141)* ___ @@ -3992,7 +3988,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -4002,7 +3998,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -4017,7 +4013,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -4025,7 +4021,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -4035,7 +4031,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -4045,7 +4041,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -4055,7 +4051,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -4065,7 +4061,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -4075,7 +4071,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
@@ -4090,7 +4086,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -4100,7 +4096,7 @@ ___ *Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -4110,7 +4106,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -4120,7 +4116,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -4130,7 +4126,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -4140,7 +4136,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -4150,7 +4146,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/44793a9cf/packages/ethereum-types/src/index.ts#L442)* +*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L442)*
@@ -4167,7 +4163,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/44793a9cf/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -4183,7 +4179,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/44793a9cf/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -4209,7 +4205,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/44793a9cf/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -4235,7 +4231,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/44793a9cf/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -4261,7 +4257,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ @@ -4269,7 +4265,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ @@ -4277,7 +4273,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -4285,7 +4281,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -4295,7 +4291,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/44793a9cf/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -4312,7 +4308,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -4331,7 +4327,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[difficulty](#difficulty)* -*Defined in [web3-wrapper/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [web3-wrapper/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L15)* ___ @@ -4341,7 +4337,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[extraData](#extradata)* -*Defined in [web3-wrapper/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [web3-wrapper/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L17)* ___ @@ -4351,7 +4347,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[gasLimit](#gaslimit)* -*Defined in [web3-wrapper/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [web3-wrapper/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L19)* ___ @@ -4361,7 +4357,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[gasUsed](#gasused)* -*Defined in [web3-wrapper/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [web3-wrapper/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L20)* ___ @@ -4371,7 +4367,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[hash](#hash)* -*Defined in [web3-wrapper/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [web3-wrapper/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L7)* ___ @@ -4381,7 +4377,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[logsBloom](#logsbloom)* -*Defined in [web3-wrapper/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [web3-wrapper/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L11)* ___ @@ -4391,7 +4387,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[miner](#miner)* -*Defined in [web3-wrapper/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [web3-wrapper/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L14)* ___ @@ -4401,7 +4397,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[nonce](#nonce)* -*Defined in [web3-wrapper/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [web3-wrapper/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L9)* ___ @@ -4411,7 +4407,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[number](#number)* -*Defined in [web3-wrapper/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [web3-wrapper/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L6)* ___ @@ -4421,7 +4417,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[parentHash](#parenthash)* -*Defined in [web3-wrapper/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [web3-wrapper/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L8)* ___ @@ -4431,7 +4427,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[sha3Uncles](#sha3uncles)* -*Defined in [web3-wrapper/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [web3-wrapper/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L10)* ___ @@ -4441,7 +4437,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[size](#size)* -*Defined in [web3-wrapper/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [web3-wrapper/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L18)* ___ @@ -4451,7 +4447,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[stateRoot](#stateroot)* -*Defined in [web3-wrapper/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [web3-wrapper/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L13)* ___ @@ -4461,7 +4457,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[timestamp](#timestamp)* -*Defined in [web3-wrapper/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [web3-wrapper/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L21)* ___ @@ -4471,7 +4467,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[totalDifficulty](#totaldifficulty)* -*Defined in [web3-wrapper/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [web3-wrapper/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L16)* ___ @@ -4479,7 +4475,7 @@ ___ • **transactions**: *string[]* -*Defined in [web3-wrapper/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L25)* +*Defined in [web3-wrapper/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L25)* ___ @@ -4489,7 +4485,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[transactionsRoot](#transactionsroot)* -*Defined in [web3-wrapper/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [web3-wrapper/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L12)* ___ @@ -4499,7 +4495,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[uncles](#uncles)* -*Defined in [web3-wrapper/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [web3-wrapper/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L22)*
@@ -4514,7 +4510,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[difficulty](#difficulty)* -*Defined in [web3-wrapper/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [web3-wrapper/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L15)* ___ @@ -4524,7 +4520,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[extraData](#extradata)* -*Defined in [web3-wrapper/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [web3-wrapper/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L17)* ___ @@ -4534,7 +4530,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[gasLimit](#gaslimit)* -*Defined in [web3-wrapper/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [web3-wrapper/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L19)* ___ @@ -4544,7 +4540,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[gasUsed](#gasused)* -*Defined in [web3-wrapper/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [web3-wrapper/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L20)* ___ @@ -4554,7 +4550,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[hash](#hash)* -*Defined in [web3-wrapper/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [web3-wrapper/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L7)* ___ @@ -4564,7 +4560,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[logsBloom](#logsbloom)* -*Defined in [web3-wrapper/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [web3-wrapper/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L11)* ___ @@ -4574,7 +4570,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[miner](#miner)* -*Defined in [web3-wrapper/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [web3-wrapper/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L14)* ___ @@ -4584,7 +4580,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[nonce](#nonce)* -*Defined in [web3-wrapper/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [web3-wrapper/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L9)* ___ @@ -4594,7 +4590,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[number](#number)* -*Defined in [web3-wrapper/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [web3-wrapper/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L6)* ___ @@ -4604,7 +4600,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[parentHash](#parenthash)* -*Defined in [web3-wrapper/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [web3-wrapper/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L8)* ___ @@ -4614,7 +4610,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[sha3Uncles](#sha3uncles)* -*Defined in [web3-wrapper/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [web3-wrapper/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L10)* ___ @@ -4624,7 +4620,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[size](#size)* -*Defined in [web3-wrapper/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [web3-wrapper/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L18)* ___ @@ -4634,7 +4630,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[stateRoot](#stateroot)* -*Defined in [web3-wrapper/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [web3-wrapper/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L13)* ___ @@ -4644,7 +4640,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[timestamp](#timestamp)* -*Defined in [web3-wrapper/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [web3-wrapper/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L21)* ___ @@ -4654,7 +4650,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[totalDifficulty](#totaldifficulty)* -*Defined in [web3-wrapper/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [web3-wrapper/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L16)* ___ @@ -4662,7 +4658,7 @@ ___ • **transactions**: *[TransactionRPC](#class-transactionrpc)[]* -*Defined in [web3-wrapper/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L28)* +*Defined in [web3-wrapper/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L28)* ___ @@ -4672,7 +4668,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[transactionsRoot](#transactionsroot)* -*Defined in [web3-wrapper/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [web3-wrapper/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L12)* ___ @@ -4682,7 +4678,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[uncles](#uncles)* -*Defined in [web3-wrapper/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [web3-wrapper/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L22)*
@@ -4697,7 +4693,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[data](#optional-data)* -*Defined in [web3-wrapper/src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [web3-wrapper/src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L76)* ___ @@ -4705,7 +4701,7 @@ ___ • **from**? : *undefined | string* -*Defined in [web3-wrapper/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L85)* +*Defined in [web3-wrapper/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L85)* ___ @@ -4715,7 +4711,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[gas](#optional-gas)* -*Defined in [web3-wrapper/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [web3-wrapper/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L74)* ___ @@ -4725,7 +4721,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[gasPrice](#optional-gasprice)* -*Defined in [web3-wrapper/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [web3-wrapper/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L75)* ___ @@ -4735,7 +4731,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[nonce](#optional-nonce)* -*Defined in [web3-wrapper/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [web3-wrapper/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L77)* ___ @@ -4745,7 +4741,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[to](#optional-to)* -*Defined in [web3-wrapper/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [web3-wrapper/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L72)* ___ @@ -4755,7 +4751,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[value](#optional-value)* -*Defined in [web3-wrapper/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L73)* +*Defined in [web3-wrapper/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L73)*
@@ -4770,7 +4766,7 @@ ___ • **address**: *string* -*Defined in [web3-wrapper/src/types.ts:64](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L64)* +*Defined in [web3-wrapper/src/types.ts:64](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L64)* ___ @@ -4778,7 +4774,7 @@ ___ • **blockHash**: *string | null* -*Defined in [web3-wrapper/src/types.ts:62](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L62)* +*Defined in [web3-wrapper/src/types.ts:62](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L62)* ___ @@ -4786,7 +4782,7 @@ ___ • **blockNumber**: *string | null* -*Defined in [web3-wrapper/src/types.ts:63](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L63)* +*Defined in [web3-wrapper/src/types.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L63)* ___ @@ -4794,7 +4790,7 @@ ___ • **data**: *string* -*Defined in [web3-wrapper/src/types.ts:65](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L65)* +*Defined in [web3-wrapper/src/types.ts:65](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L65)* ___ @@ -4802,7 +4798,7 @@ ___ • **logIndex**: *string | null* -*Defined in [web3-wrapper/src/types.ts:59](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L59)* +*Defined in [web3-wrapper/src/types.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L59)* ___ @@ -4810,7 +4806,7 @@ ___ • **topics**: *string[]* -*Defined in [web3-wrapper/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L66)* +*Defined in [web3-wrapper/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L66)* ___ @@ -4818,7 +4814,7 @@ ___ • **transactionHash**: *string* -*Defined in [web3-wrapper/src/types.ts:61](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L61)* +*Defined in [web3-wrapper/src/types.ts:61](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L61)* ___ @@ -4826,7 +4822,7 @@ ___ • **transactionIndex**: *string | null* -*Defined in [web3-wrapper/src/types.ts:60](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L60)* +*Defined in [web3-wrapper/src/types.ts:60](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L60)*
@@ -4839,7 +4835,7 @@ ___ • **blockHash**: *string* -*Defined in [web3-wrapper/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L45)* +*Defined in [web3-wrapper/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L45)* ___ @@ -4847,7 +4843,7 @@ ___ • **blockNumber**: *string* -*Defined in [web3-wrapper/src/types.ts:46](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L46)* +*Defined in [web3-wrapper/src/types.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L46)* ___ @@ -4855,7 +4851,7 @@ ___ • **contractAddress**: *string | null* -*Defined in [web3-wrapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L54)* +*Defined in [web3-wrapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L54)* ___ @@ -4863,7 +4859,7 @@ ___ • **cumulativeGasUsed**: *string* -*Defined in [web3-wrapper/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L52)* +*Defined in [web3-wrapper/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L52)* ___ @@ -4871,7 +4867,7 @@ ___ • **from**: *string* -*Defined in [web3-wrapper/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L49)* +*Defined in [web3-wrapper/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L49)* ___ @@ -4879,7 +4875,7 @@ ___ • **gasUsed**: *string* -*Defined in [web3-wrapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L53)* +*Defined in [web3-wrapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L53)* ___ @@ -4887,7 +4883,7 @@ ___ • **logs**: *[LogEntryRPC](#class-logentryrpc)[]* -*Defined in [web3-wrapper/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L55)* +*Defined in [web3-wrapper/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L55)* ___ @@ -4895,7 +4891,7 @@ ___ • **status**: *[TransactionReceiptStatusRPC](#transactionreceiptstatusrpc)* -*Defined in [web3-wrapper/src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L51)* +*Defined in [web3-wrapper/src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L51)* ___ @@ -4903,7 +4899,7 @@ ___ • **to**: *string* -*Defined in [web3-wrapper/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L50)* +*Defined in [web3-wrapper/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L50)* ___ @@ -4911,7 +4907,7 @@ ___ • **transactionHash**: *string* -*Defined in [web3-wrapper/src/types.ts:47](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L47)* +*Defined in [web3-wrapper/src/types.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L47)* ___ @@ -4919,7 +4915,7 @@ ___ • **transactionIndex**: *string* -*Defined in [web3-wrapper/src/types.ts:48](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L48)* +*Defined in [web3-wrapper/src/types.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L48)*
@@ -4932,7 +4928,7 @@ ___ • **blockHash**: *string | null* -*Defined in [web3-wrapper/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L33)* +*Defined in [web3-wrapper/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L33)* ___ @@ -4940,7 +4936,7 @@ ___ • **blockNumber**: *string | null* -*Defined in [web3-wrapper/src/types.ts:34](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L34)* +*Defined in [web3-wrapper/src/types.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L34)* ___ @@ -4948,7 +4944,7 @@ ___ • **from**: *string* -*Defined in [web3-wrapper/src/types.ts:36](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L36)* +*Defined in [web3-wrapper/src/types.ts:36](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L36)* ___ @@ -4956,7 +4952,7 @@ ___ • **gas**: *string* -*Defined in [web3-wrapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L40)* +*Defined in [web3-wrapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L40)* ___ @@ -4964,7 +4960,7 @@ ___ • **gasPrice**: *string* -*Defined in [web3-wrapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L39)* +*Defined in [web3-wrapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L39)* ___ @@ -4972,7 +4968,7 @@ ___ • **hash**: *string* -*Defined in [web3-wrapper/src/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L31)* +*Defined in [web3-wrapper/src/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L31)* ___ @@ -4980,7 +4976,7 @@ ___ • **input**: *string* -*Defined in [web3-wrapper/src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L41)* +*Defined in [web3-wrapper/src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L41)* ___ @@ -4988,7 +4984,7 @@ ___ • **nonce**: *string* -*Defined in [web3-wrapper/src/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L32)* +*Defined in [web3-wrapper/src/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L32)* ___ @@ -4996,7 +4992,7 @@ ___ • **to**: *string | null* -*Defined in [web3-wrapper/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L37)* +*Defined in [web3-wrapper/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L37)* ___ @@ -5004,7 +5000,7 @@ ___ • **transactionIndex**: *string | null* -*Defined in [web3-wrapper/src/types.ts:35](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L35)* +*Defined in [web3-wrapper/src/types.ts:35](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L35)* ___ @@ -5012,7 +5008,7 @@ ___ • **value**: *string* -*Defined in [web3-wrapper/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L38)* +*Defined in [web3-wrapper/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L38)*
@@ -5027,7 +5023,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[data](#optional-data)* -*Defined in [web3-wrapper/src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [web3-wrapper/src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L76)* ___ @@ -5035,7 +5031,7 @@ ___ • **from**: *string* -*Defined in [web3-wrapper/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L81)* +*Defined in [web3-wrapper/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L81)* ___ @@ -5045,7 +5041,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[gas](#optional-gas)* -*Defined in [web3-wrapper/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [web3-wrapper/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L74)* ___ @@ -5055,7 +5051,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[gasPrice](#optional-gasprice)* -*Defined in [web3-wrapper/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [web3-wrapper/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L75)* ___ @@ -5065,7 +5061,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[nonce](#optional-nonce)* -*Defined in [web3-wrapper/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [web3-wrapper/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L77)* ___ @@ -5075,7 +5071,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[to](#optional-to)* -*Defined in [web3-wrapper/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [web3-wrapper/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L72)* ___ @@ -5085,20 +5081,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[value](#optional-value)* -*Defined in [web3-wrapper/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/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/44793a9cf/packages/web3-wrapper/src/types.ts#L69)* +*Defined in [web3-wrapper/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/types.ts#L73)*
@@ -5111,7 +5094,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/44793a9cf/packages/ethereum-types/src/index.ts#L80)* +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L80)* ___ @@ -5119,7 +5102,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L483)* +*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L483)* ___ @@ -5127,7 +5110,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L84)* ___ @@ -5137,7 +5120,7 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L468)* +*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L468)* ___ @@ -5147,7 +5130,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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 @@ -5162,7 +5145,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/44793a9cf/packages/ethereum-types/src/index.ts#L82)* +*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L82)* ___ @@ -5170,7 +5153,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -5189,7 +5172,7 @@ ___ Ƭ **LogTopic**: *null | string | string[]* -*Defined in [ethereum-types/src/index.ts:413](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L413)* +*Defined in [ethereum-types/src/index.ts:413](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L413)* ___ @@ -5201,7 +5184,7 @@ ___ Ƭ **RawLog**: *[LogEntry](#interface-logentry)* -*Defined in [ethereum-types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L475)* +*Defined in [ethereum-types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L475)* ___ @@ -5209,7 +5192,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L85)* ___ @@ -5217,7 +5200,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/44793a9cf/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/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. @@ -5228,7 +5211,7 @@ ___ Ƭ **TransactionReceiptStatus**: *null | string | `0` | `1`* -*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/ethereum-types/src/index.ts#L445)* +*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L445)* ___ @@ -5238,7 +5221,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/44793a9cf/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)*
@@ -5255,7 +5238,7 @@ ___ #### ▪ **marshaller**: *object* -*Defined in [web3-wrapper/src/marshaller.ts:33](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L33)* +*Defined in [web3-wrapper/src/marshaller.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L33)* Utils to convert ethereum structures from user-space format to RPC format. (marshall/unmarshall) @@ -5263,7 +5246,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/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L208)* +*Defined in [web3-wrapper/src/marshaller.ts:208](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L208)* **Parameters:** @@ -5277,7 +5260,7 @@ Name | Type | ▸ **marshalAddress**(`address`: string): *string* -*Defined in [web3-wrapper/src/marshaller.ts:176](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L176)* +*Defined in [web3-wrapper/src/marshaller.ts:176](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L176)* Marshall address @@ -5295,7 +5278,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/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L187)* +*Defined in [web3-wrapper/src/marshaller.ts:187](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L187)* Marshall block param @@ -5313,7 +5296,7 @@ marshalled block param ▸ **marshalCallData**(`callData`: `Partial`): *`Partial`* -*Defined in [web3-wrapper/src/marshaller.ts:159](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L159)* +*Defined in [web3-wrapper/src/marshaller.ts:159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L159)* Marshall call data @@ -5331,7 +5314,7 @@ marshalled call data ▸ **marshalTxData**(`txData`: `Partial`): *`Partial`* -*Defined in [web3-wrapper/src/marshaller.ts:133](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L133)* +*Defined in [web3-wrapper/src/marshaller.ts:133](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L133)* Marshall transaction data @@ -5349,7 +5332,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/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L59)* +*Defined in [web3-wrapper/src/marshaller.ts:59](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L59)* Unmarshall block with transaction data @@ -5367,7 +5350,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/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L39)* +*Defined in [web3-wrapper/src/marshaller.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L39)* Unmarshall block without transaction data @@ -5385,7 +5368,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/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L199)* +*Defined in [web3-wrapper/src/marshaller.ts:199](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L199)* Unmarshall log @@ -5403,7 +5386,7 @@ unmarshalled log ▸ **unmarshalTransaction**(`txRpc`: [TransactionRPC](#interface-transactionrpc)): *`Transaction`* -*Defined in [web3-wrapper/src/marshaller.ts:82](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L82)* +*Defined in [web3-wrapper/src/marshaller.ts:82](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L82)* Unmarshall transaction @@ -5421,7 +5404,7 @@ unmarshalled transaction ▸ **unmarshalTransactionReceipt**(`txReceiptRpc`: [TransactionReceiptRPC](#interface-transactionreceiptrpc)): *`TransactionReceipt`* -*Defined in [web3-wrapper/src/marshaller.ts:99](https://github.com/0xProject/0x-monorepo/blob/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L99)* +*Defined in [web3-wrapper/src/marshaller.ts:99](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L99)* Unmarshall transaction receipt @@ -5439,7 +5422,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/44793a9cf/packages/web3-wrapper/src/marshaller.ts#L115)* +*Defined in [web3-wrapper/src/marshaller.ts:115](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/web3-wrapper/src/marshaller.ts#L115)* Unmarshall transaction data @@ -5455,3 +5438,20 @@ 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/9fe6c196a/packages/web3-wrapper/src/types.ts#L69)* + +
+ + + +
+