diff --git a/contracts/asset-proxy/CHANGELOG.json b/contracts/asset-proxy/CHANGELOG.json index 1254aa3767..d9d6329dc4 100644 --- a/contracts/asset-proxy/CHANGELOG.json +++ b/contracts/asset-proxy/CHANGELOG.json @@ -26,7 +26,8 @@ "note": "Add `Eth2DaiBridge`", "pr": 2221 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/asset-proxy/CHANGELOG.md b/contracts/asset-proxy/CHANGELOG.md index aa67ce34fd..25bcca7ba1 100644 --- a/contracts/asset-proxy/CHANGELOG.md +++ b/contracts/asset-proxy/CHANGELOG.md @@ -5,6 +5,15 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## 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) + * Remove `LibAssetProxyIds` contract (#2055) + * Compile and export all contracts, artifacts, and wrappers by default (#2055) + * Remove unused dependency on IAuthorizable in IAssetProxy (#1910) + * Add `ERC20BridgeProxy` (#2220) + * Add `Eth2DaiBridge` (#2221) + ## v2.2.8 - _September 17, 2019_ * Dependencies updated @@ -58,6 +67,9 @@ CHANGELOG ## v2.1.2 - _May 10, 2019_ * Update tests to use contract-built-in `awaitTransactionSuccessAsync` (#1797) + * Make `ERC721Wrapper.setApprovalForAll()` take an owner address instead of a token ID (#1819) + * Automatically set unlimited proxy allowances in `ERC721.setBalancesAndAllowancesAsync()` (#1819) + * Add `setProxyAllowanceForAllAsync()` to `ERC1155ProxyWrapper`. (#1819) ## v2.1.1 - _April 11, 2019_ diff --git a/contracts/coordinator/CHANGELOG.json b/contracts/coordinator/CHANGELOG.json index 36f8ea116c..b3f739d5e1 100644 --- a/contracts/coordinator/CHANGELOG.json +++ b/contracts/coordinator/CHANGELOG.json @@ -42,7 +42,8 @@ "note": "Compile and export all contracts, artifacts, and wrappers by default", "pr": 2055 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/coordinator/CHANGELOG.md b/contracts/coordinator/CHANGELOG.md index 839affd07a..9ef81f5645 100644 --- a/contracts/coordinator/CHANGELOG.md +++ b/contracts/coordinator/CHANGELOG.md @@ -5,6 +5,19 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.1.0-beta.0 - _October 3, 2019_ + + * Add chainId to domain separator (#1742) + * Inherit Exchange domain constants from `exchange-libs` to reduce code duplication (#1742) + * Update domain separator (#1742) + * Refactor contract to use new ITransactions interface (#1753) + * Add verifyingContractIfExists arg to LibEIP712CoordinatorDomain constructor (#1753) + * Remove LibZeroExTransaction contract (#1753) + * Update tests for arbitrary fee tokens (ZEIP-28). (#1819) + * Update for new `marketXOrders` consolidation. (#2042) + * Use built in selectors instead of hard coded constants (#2055) + * Compile and export all contracts, artifacts, and wrappers by default (#2055) + ## v2.0.13 - _September 17, 2019_ * Dependencies updated diff --git a/contracts/dev-utils/CHANGELOG.json b/contracts/dev-utils/CHANGELOG.json index 27865b5070..b2bafed5a6 100644 --- a/contracts/dev-utils/CHANGELOG.json +++ b/contracts/dev-utils/CHANGELOG.json @@ -18,7 +18,8 @@ "note": "`run_mocha` package script runs with `UNLIMITED_CONTRACT_SIZE=true` environment variable.", "pr": 2075 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/dev-utils/CHANGELOG.md b/contracts/dev-utils/CHANGELOG.md index 6630b989ff..c2e84ae8ca 100644 --- a/contracts/dev-utils/CHANGELOG.md +++ b/contracts/dev-utils/CHANGELOG.md @@ -5,6 +5,13 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v0.1.0-beta.0 - _October 3, 2019_ + + * Use built in selectors instead of hard coded constants (#2055) + * Compile and export all contracts, artifacts, and wrappers by default (#2055) + * Add `marketBuy/SellOrdersNoThrow` and `marketBuy/SellOrdersFillOrKill` to `LibTransactionDecoder`. (#2075) + * `run_mocha` package script runs with `UNLIMITED_CONTRACT_SIZE=true` environment variable. (#2075) + ## v0.0.10 - _September 17, 2019_ * Dependencies updated @@ -53,3 +60,5 @@ CHANGELOG * Refactor `LibAssetData` balance/allowance checks to never revert (#1848) * Refactor `OrderValidationUtils` to calculate `fillableTakerAssetAmount` (#1848) * Add support for StaticCallProxy (#1863) + * Add `OrderTransferSimulationUtils` contract for simulating order transfers on-chain (#1868) + * Updated to use the new rich error pattern from @0x/contracts-exchange (#1913) diff --git a/contracts/erc1155/CHANGELOG.json b/contracts/erc1155/CHANGELOG.json index 98933fa5cd..b2d85d92cc 100644 --- a/contracts/erc1155/CHANGELOG.json +++ b/contracts/erc1155/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Add `mintKnownFungibleTokensAsync()`, `isNonFungibleItemAsync()`, `isFungibleItemAsync()`, `getOwnerOfAsync()`, `getBalanceAsync()` to `Erc1155Wrapper`.", "pr": 1819 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/erc1155/CHANGELOG.md b/contracts/erc1155/CHANGELOG.md index fbc7809552..458e81314a 100644 --- a/contracts/erc1155/CHANGELOG.md +++ b/contracts/erc1155/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v1.2.0-beta.0 - _October 3, 2019_ + + * Add `mintKnownFungibleTokensAsync()`, `isNonFungibleItemAsync()`, `isFungibleItemAsync()`, `getOwnerOfAsync()`, `getBalanceAsync()` to `Erc1155Wrapper`. (#1819) + ## v1.1.15 - _September 17, 2019_ * Dependencies updated diff --git a/contracts/erc20/CHANGELOG.json b/contracts/erc20/CHANGELOG.json index a7375c368e..4c349e24df 100644 --- a/contracts/erc20/CHANGELOG.json +++ b/contracts/erc20/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/erc20/CHANGELOG.md b/contracts/erc20/CHANGELOG.md index c4719e70fc..66b597911c 100644 --- a/contracts/erc20/CHANGELOG.md +++ b/contracts/erc20/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.3.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v2.2.14 - _September 17, 2019_ * Dependencies updated diff --git a/contracts/erc721/CHANGELOG.json b/contracts/erc721/CHANGELOG.json index 9874270f75..7b77e700de 100644 --- a/contracts/erc721/CHANGELOG.json +++ b/contracts/erc721/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/erc721/CHANGELOG.md b/contracts/erc721/CHANGELOG.md index 96b580c4aa..ac1e62b0ba 100644 --- a/contracts/erc721/CHANGELOG.md +++ b/contracts/erc721/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.2.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v2.1.15 - _September 17, 2019_ * Dependencies updated diff --git a/contracts/exchange-forwarder/CHANGELOG.json b/contracts/exchange-forwarder/CHANGELOG.json index 75f246baa3..59f2d977e5 100644 --- a/contracts/exchange-forwarder/CHANGELOG.json +++ b/contracts/exchange-forwarder/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/exchange-forwarder/CHANGELOG.md b/contracts/exchange-forwarder/CHANGELOG.md index 8cab4131f1..ec731fef65 100644 --- a/contracts/exchange-forwarder/CHANGELOG.md +++ b/contracts/exchange-forwarder/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.1.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v3.0.12 - _September 17, 2019_ * Dependencies updated diff --git a/contracts/exchange-libs/CHANGELOG.json b/contracts/exchange-libs/CHANGELOG.json index 6fc8af8a76..9fd46bc262 100644 --- a/contracts/exchange-libs/CHANGELOG.json +++ b/contracts/exchange-libs/CHANGELOG.json @@ -106,7 +106,8 @@ "note": "Update `IncompleteFillError` to take an `errorCode`, `expectedAssetFillAmount`, and `actualAssetFillAmount` fields.", "pr": 2075 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/exchange-libs/CHANGELOG.md b/contracts/exchange-libs/CHANGELOG.md index 2a1cad2768..80cb7c81aa 100644 --- a/contracts/exchange-libs/CHANGELOG.md +++ b/contracts/exchange-libs/CHANGELOG.md @@ -5,6 +5,35 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.1.0-beta.0 - _October 3, 2019_ + + * Break up `LibEIP712` into reusable components (#1742) + * Add `chainId` to EIP712 domain schema (#1742) + * Rename `verifyingContract` to `verifyingContractAddress` in domain schema (#1742) + * Add LibZeroExTransaction contract (#1753) + * Add verifyingContractIfExists arg to LibEIP712ExchangeDomain constructor (#1753) + * Remove LibEIP712ExchangeDomainConstants and LibEIP712 contracts (#1753) + * Add `LibExchangeRichErrorDecoder` contract. (#1790) + * Break out types/interaces from `MExchangeRichErrors` into `MExchangeRichErrorTypes`. (#1790) + * Reorder some revert error parameters for consistency (#1790) + * Add new `Order` fields for arbitrary fee tokens (ZEIP-28). (#1819) + * Remove `LibAbiEncoder` and `LibConstants`. (#1819) + * Add `generate-exchange-selectors` package script. (#1819) + * Add `expirationTimeSeconds` to `ZeroExTransaction` struct (#1823) + * Add reference functions for `LibMath` and `LibFillResults` (#2031) + * Move in revamped `LibMath` tests from the `contracts-exchange` package. (#2031) + * Move in revamped `LibFillResults` tests from the `contracts-exchange` package. (#2031) + * Remove unecessary zero-denominator checks in `LibMath`. (#2031) + * Fix coverage hooks. (#2031) + * Regenerate selectors. (#2042) + * Convert `LibFillResults`, `LibOrder`, `LibZeroExTransaction`, and `LibMath` to libraries (#2055) + * Remove `LibExchangeSelectors` (#2055) + * Add `LibExchangeRichErrors` (#2055) + * Add `calculateFillResults` and `calculateMatchedFillResults` to `LibFillResults` (#2055) + * 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) + ## v3.0.8 - _September 17, 2019_ * Dependencies updated diff --git a/contracts/exchange/CHANGELOG.json b/contracts/exchange/CHANGELOG.json index afc115d905..741ff3f973 100644 --- a/contracts/exchange/CHANGELOG.json +++ b/contracts/exchange/CHANGELOG.json @@ -190,7 +190,8 @@ "note": "Overridden functions in `ReentrancyTester` now return sane values.", "pr": 2075 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/exchange/CHANGELOG.md b/contracts/exchange/CHANGELOG.md index f033196b0f..7850919cf0 100644 --- a/contracts/exchange/CHANGELOG.md +++ b/contracts/exchange/CHANGELOG.md @@ -5,6 +5,56 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.2.0-beta.0 - _October 3, 2019_ + + * Use new/cheaper reentrancy guard/mutex (#1699) + * Update domain separator (#1742) + * Refactor `executeTransaction` to take `ZeroExTransaction` struct as input (#1753) + * Refactor example contracts that use `executeTransaction` (#1753) + * Upgrade all string reverts to rich reverts (#1761) + * Add support for `SignatureType.OrderValidator` for orders (#1774) + * Add support for `SignatureType.WalletOrderValidator` for orders (#1774) + * Add a `bytes` return value to `executeTransaction`, which is equal to the encoded return data of the underlying Exchange function call (#1793) + * Implement `batchExecuteTransactions` (#1793) + * Refactor preSign to be compatible with `executeTransaction` (#1793) + * Remove ZRX fees in lieu of arbitrary maker and taker fee tokens. (#1819) + * Incorporate Multi-asset and ERC1155 tests into `fillOrder` and `matchOrders` tests (#1819) + * Swap fill order from maker -> taker to taker -> maker (#1819) + * Avoid redundant transfer in `fillOrder()` and `matchOrders()` when maker/taker is the same as feeRecipient and assets are the same (#1819) + * Implement `cancelOrderNoThrow` and `batchCancelOrdersNoThrow` functions (#1827) + * `executeTransaction` will now revert if the input transaction is expired (#1832) + * Log an `TransactionExecuted` event when an `executeTransaction` call is successful (#1832) + * Return a FillResults array for batch fill variants (#1834) + * Add `MixinTransferSimulator` contract for simulating multiple transfers on-chain (#1868) + * Add `EIP1271Wallet` signature type (#1885) + * Remove `WalletOrderValidator` and `OrderValidator` signature types (#1885) + * Make the regular `Validator` signature type have EIP1271 behavior (#1885) + * Always check signature types that are validated via contract (not just on first fill). (#1885) + * Remove unecessary rich revert error types. (#1885) + * Add `IEIP1271Wallet` interface (#1885) + * Add `validatorAddress` field to `SignatureValidatorError` rich reverts (#1885) + * Make `calculateMatchedFillResults` public (#1885) + * Updated RichErrors to the library pattern (#1913) + * Rewrote _dispatchTransferFrom in Solidity (#2020) + * Add `TestIsolatedExchange` contract and `IsolatedExchangeWrapper` test class (#2031) + * Add `ReferenceFunctions` as package export. (#2031) + * Remove `TestExchangeMath.sol`. Exchange math functions are now tested in the `exchange-libs` package and reference implementations are available there as well. (#2031) + * Remove functions from `TestExchangeInternals.sol` that are no longer tested in this package. (#2031) + * Remove `_assertValidFill()` (#2031) + * Add `wrapper_unit_tests` tests and `TestWrapperFunctions` contract (#2042) + * Disallow `signerAddress == 0` in signature validation functions. (#2042) + * Update `Wallet` signature type behavior to be in line with v2.1. (#2042) + * Add (semi) automated reentrancy tests and remove manual ones (#2042) + * Refactor to use new `LibFillResults`, `LibOrder`, `LibZeroExTransaction`, and `LibMath` to libraries (#2055) + * Remove `LibExchangeRichErrors` and `IExchangeRichErrors` (#2055) + * Use built in selectors instead of `LibExchangeSelectors` constants (#2055) + * Move `calculateFillResults` and `calculateMatchedFillResults` to `LibFillResults` in `exchange-libs` package (#2055) + * Compile and export all contracts, artifacts, and wrappers by default (#2055) + * Rename `marketSellOrders` and `marketBuyOrders` back to `marketSellOrdersNoThrow` and `marketBuyOrdersNoThrow`. (#2075) + * Introduce new `marketSellOrdersFillOrKill` and `marketBuyOrdersFillOrKill` functions. (#2075) + * Use `abi.decode()` in `LibExchangeRichErrorDecoder` over `LibBytes`. (#2075) + * Overridden functions in `ReentrancyTester` now return sane values. (#2075) + ## v2.1.14 - _September 17, 2019_ * Dependencies updated diff --git a/contracts/extensions/CHANGELOG.json b/contracts/extensions/CHANGELOG.json index a6e0fef7dd..e357e80602 100644 --- a/contracts/extensions/CHANGELOG.json +++ b/contracts/extensions/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/extensions/CHANGELOG.md b/contracts/extensions/CHANGELOG.md index 42c4456624..71ef8b1e5c 100644 --- a/contracts/extensions/CHANGELOG.md +++ b/contracts/extensions/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v4.1.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v4.0.8 - _September 17, 2019_ * Dependencies updated @@ -40,6 +44,9 @@ CHANGELOG ## v4.0.0 - _July 13, 2019_ * Move `OrderValidator` to contracts/dev-utils package as `OrderValidationUtils` (#1848) + * Remove unused `LibOrder` inheritance (#1742) + * Refactor BalanceThresholdFilter to use new ITransactions interface (#1753) + * Update tests for rich reverts (#1761) ## v3.1.5 - _May 24, 2019_ diff --git a/contracts/multisig/CHANGELOG.json b/contracts/multisig/CHANGELOG.json index f6b963104d..281deebef7 100644 --- a/contracts/multisig/CHANGELOG.json +++ b/contracts/multisig/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/multisig/CHANGELOG.md b/contracts/multisig/CHANGELOG.md index 7be0bb3a07..bc562e51c2 100644 --- a/contracts/multisig/CHANGELOG.md +++ b/contracts/multisig/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.2.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v3.1.14 - _September 17, 2019_ * Dependencies updated diff --git a/contracts/staking/CHANGELOG.json b/contracts/staking/CHANGELOG.json index 8742b56975..8c747dbbee 100644 --- a/contracts/staking/CHANGELOG.json +++ b/contracts/staking/CHANGELOG.json @@ -70,6 +70,7 @@ "note": "Removed explicit dependency on epoch+1 when delegating.", "pr": 2188 } - ] + ], + "timestamp": 1570135330 } ] diff --git a/contracts/staking/CHANGELOG.md b/contracts/staking/CHANGELOG.md index 1004e94271..09c8668a43 100644 --- a/contracts/staking/CHANGELOG.md +++ b/contracts/staking/CHANGELOG.md @@ -4,3 +4,23 @@ Edit the package's CHANGELOG.json file only. --> CHANGELOG + +## v1.1.0-beta.0 - _October 3, 2019_ + + * Created package (#1821) + * First implementation (#1910) + * Replace `LibFeeMath` with `LibFixedMath`. (#2109) + * Use a more precise cobb-douglas implementation. (#2109) + * Change the way operator stake is computed. (#2109) + * Denominate pool operator shares in parts-per-million. (#2109) + * New stake management mechanics. Delay before delegation. Nixed shadow rewards. (#2118) + * Tests for new stake management mechanics. (#2126) + * Add `init()` pattern to contracts. (#2131) + * Replace `MixinDeploymentConstants` with `MixinParams`. (#2131) + * Reference counting for cumulative rewards. (#2154) + * Refactored Staking Reward Vault. Moved pool management logic into staking contract. (#2156) + * Removed MixinStakingPoolRewardVault.sol (#2156) + * Refactored out `_cobbDouglas()` into its own library (#2179) + * Introduce multi-block finalization. (#2155) + * Removed reference counting for cumulative rewards. (#2188) + * Removed explicit dependency on epoch+1 when delegating. (#2188) diff --git a/contracts/test-utils/CHANGELOG.json b/contracts/test-utils/CHANGELOG.json index 282dcd9817..c9655a02a2 100644 --- a/contracts/test-utils/CHANGELOG.json +++ b/contracts/test-utils/CHANGELOG.json @@ -98,7 +98,8 @@ "note": "Add `number_utils.ts` and `hexSize()`", "pr": 2220 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/test-utils/CHANGELOG.md b/contracts/test-utils/CHANGELOG.md index 569ef8120d..de99badf7d 100644 --- a/contracts/test-utils/CHANGELOG.md +++ b/contracts/test-utils/CHANGELOG.md @@ -5,6 +5,33 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.2.0-beta.0 - _October 3, 2019_ + + * Add `chainId` to `TransactionFactory` constructor (#1742) + * Use new `Order` structure with `domain` field (#1742) + * Inherit `chaiSetup` from `@0x/dev-utils` (#1761) + * Add `generatePseudoRandomOrderHash()` to `orderUtils` (#1761) + * Inherit `OrderStatus` from `@0x/types` (#1761) + * Update types for arbitrary fee tokens (#1819) + * Remove formatters (#1834) + * Add `hexConcat()` in `hex_utils.ts` (#1885) + * Introduce Mocha blockchain extensions (#2007) + * Move `*FillResults`, `OrderInfo` types to `@0x/types` (#2031) + * Add `log_utils.ts` (#2031) + * Add `haxRandom()` to `hex_utils.ts` (#2031) + * Add the constants: `MAX_UINT256`, `ADDRESS_LENGTH`, `MAX_UINT256_ROOT`, `ONE_ETHER` (#2031) + * Make `testCombinatoriallyWithReferenceFuncAsync` non-async (#2031) + * Update `testWithReferenceFuncAsync` to work with `RevertErrors` (#2031) + * `web3Wrapper` is created with `shouldAllowUnlimitedContractSize` if `UNLIMITED_CONTRACT_SIZE` environment variable is set. (#2075) + * Add `toHex()`, `hexLeftPad()`, `hexRightPad()`, and 'hexInvert()' hex utils (#2109) + * Add `PPM_DENOMINATOR` and `PPM_100_PERCENT` constants. (#2109) + * Increase the number of ganache accounts to 20 (#2109) + * Add `Numberish` type. (#2131) + * Tweaks/Upgrades to `hex_utils`, most notably `hexSlice()` (#2155) + * Add `hexHash()` to `hex_utils` (#2155) + * Add `shortZip()` to `lang_utils.ts` (#2155) + * Add `number_utils.ts` and `hexSize()` (#2220) + ## v3.1.16 - _September 17, 2019_ * Dependencies updated diff --git a/contracts/utils/CHANGELOG.json b/contracts/utils/CHANGELOG.json index 1940438ff0..ecd5d1401a 100644 --- a/contracts/utils/CHANGELOG.json +++ b/contracts/utils/CHANGELOG.json @@ -62,7 +62,8 @@ "note": "Introduce automatic normalization and some zero-value shortcuts in `LibFractions`.", "pr": 2155 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/contracts/utils/CHANGELOG.md b/contracts/utils/CHANGELOG.md index 54eaa536c4..61bb5936f8 100644 --- a/contracts/utils/CHANGELOG.md +++ b/contracts/utils/CHANGELOG.md @@ -5,6 +5,24 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.3.0-beta.0 - _October 3, 2019_ + + * Change ReentrancyGuard implementation to cheaper one (#1699) + * Add LibEIP712 contract (#1753) + * Add `RichErrors` and `mixins/MRichErrors` (#1761) + * Break out types/interaces from `MRichErrors` into `MRichErrorTypes`. (#1790) + * Add LibEIP1271.sol (#1885) + * Updated RichErrors to the library pattern, and implemented RichErrors for all remaining reverts and requires (#1913) + * Added unit tests for all of the internal functions in the package (#2014) + * Updated Ownable to revert when the owner attempts to transfer ownership to the zero address (#2019) + * Add reference functions for `SafeMath` functions. (#2031) + * Throw a `SafeMathError` in `SafeMath._safeDiv()` when denominator is zero. (#2031) + * Create `LibSafeMath` (#2055) + * Rename `_rrevert` to `rrevert` in `LibRichErrors` contract (#2055) + * 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) + ## v3.2.4 - _September 17, 2019_ * Dependencies updated diff --git a/packages/0x.js/CHANGELOG.json b/packages/0x.js/CHANGELOG.json index e52696efde..e0e2540d12 100644 --- a/packages/0x.js/CHANGELOG.json +++ b/packages/0x.js/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Updated to work with 0x v3" } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/packages/0x.js/CHANGELOG.md b/packages/0x.js/CHANGELOG.md index cc13f731fd..3a42df6373 100644 --- a/packages/0x.js/CHANGELOG.md +++ b/packages/0x.js/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v7.1.0-beta.0 - _October 3, 2019_ + + * Updated to work with 0x v3 + ## v7.0.2 - _September 17, 2019_ * Dependencies updated diff --git a/packages/0x.js/docs/reference.mdx b/packages/0x.js/docs/reference.mdx index 6718431846..038b1c97aa 100644 --- a/packages/0x.js/docs/reference.mdx +++ b/packages/0x.js/docs/reference.mdx @@ -1,28 +1,27 @@ - - -# Class: CoordinatorRegistryContract +# Class: DevUtilsContract ## Constructors -\+ **new CoordinatorRegistryContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* +\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DevUtilsContract](#class-devutilscontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:516](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L516)* +*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 | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | DevUtilsContract.deployedBytecode | -**Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* +**Returns:** *[DevUtilsContract](#class-devutilscontract)* ## Properties @@ -32,7 +31,7 @@ Name | Type | -Defined in base-contract/lib/src/index.d.ts:25 +Defined in base-contract/lib/src/index.d.ts:27 ___ @@ -42,7 +41,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:26 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -52,7 +51,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -62,7 +61,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +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 @@ -72,7 +79,7 @@ Defined in base-contract/lib/src/index.d.ts:27 -Defined in base-contract/lib/src/index.d.ts:38 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -84,95 +91,11 @@ Name | Type | ___ -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:500](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L500)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | The CoordinatorRegistry contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:458](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L458)* - -Subscribe to an event type emitted by the CoordinatorRegistry contract. - -**Type parameters:** - -▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | - | The CoordinatorRegistry contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:483](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L483)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:489](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L489)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:386](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L386)* +*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)* @@ -182,9 +105,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:344](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L344)* +*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:** @@ -195,16 +118,17 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | +`_exchange` | string | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:313](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L313)* +*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:** @@ -214,8 +138,9 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | +`_exchange` | string | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ @@ -225,7 +150,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:37 +Defined in base-contract/lib/src/index.d.ts:41 **Parameters:** @@ -238,19 +163,19 @@ Name | Type | ## Object literals -### getCoordinatorEndpoint +### decodeAssetProxyDispatchError -#### ▪ **getCoordinatorEndpoint**: *object* +#### ▪ **decodeAssetProxyDispatchError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:227](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L227)* +*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)* -Gets the endpoint for a Coordinator. +Decompose an ABI-encoded AssetProxyDispatchError. #### callAsync -▸ **callAsync**(`coordinatorOperator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:234](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L234)* +*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 @@ -260,17 +185,19 @@ since they don't modify state. Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`coordinatorOperator` | string | - | operator of the Coordinator endpoint. | +`encoded` | string | - | ABI-encoded revert error. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise`* +**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): *string* +▸ **getABIDecodedReturnData**(`returnData`: string): *[number, string, string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:304](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L304)* +*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 @@ -280,134 +207,7 @@ Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L292)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`coordinatorOperator`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:279](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L279)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`coordinatorOperator` | string | operator of the Coordinator endpoint. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### setCoordinatorEndpoint - -#### ▪ **setCoordinatorEndpoint**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L52)* - -Called by a Coordinator operator to set the endpoint of their Coordinator. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L88)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`coordinatorEndpoint` | string | endpoint of the Coordinator. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`coordinatorEndpoint`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:148](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L148)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`coordinatorEndpoint` | string | - | endpoint of the Coordinator. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:115](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L115)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`coordinatorEndpoint` | string | endpoint of the Coordinator. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:216](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L216)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* +**Returns:** *[number, string, string]* An array representing the output results in order. Keynames of nested structs are preserved. @@ -415,7 +215,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:204](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L204)* +*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 @@ -431,9 +231,9 @@ An array representing the input arguments in order. Keynames of nested structs a #### getABIEncodedTransactionData -▸ **getABIEncodedTransactionData**(`coordinatorEndpoint`: string): *string* +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:191](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L191)* +*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 @@ -443,218 +243,27 @@ to create a 0x transaction (see protocol spec for more details). Name | Type | Description | ------ | ------ | ------ | -`coordinatorEndpoint` | string | endpoint of the Coordinator. | +`encoded` | string | ABI-encoded revert error. | **Returns:** *string* The ABI encoded transaction data as a string -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L60)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`coordinatorEndpoint` | string | endpoint of the Coordinator. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:134](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L134)* - -**Parameters:** - -Name | Type | ------- | ------ | -`coordinatorEndpoint` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -
- -# Class: DevUtilsContract - - -## Constructors - - - -\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DevUtilsContract](#class-devutilscontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3329)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[DevUtilsContract](#class-devutilscontract)* - -## Properties - -#### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - ___ -### address +### decodeAssetProxyExistsError -• **address**: *string* +#### ▪ **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)* - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2549](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2549)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2501](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2501)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | -`_zrxAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2466](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2466)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | -`_zrxAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### ERC1155_PROXY_ID - -#### ▪ **ERC1155_PROXY_ID**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:206](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L206)* +Decompose an ABI-encoded AssetProxyExistsError. #### callAsync -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L212)* +*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 @@ -662,18 +271,21 @@ since they don't modify state. **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise<[string, string]>`* + +assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy. #### getABIDecodedReturnData -▸ **getABIDecodedReturnData**(`returnData`: string): *string* +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:271](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L271)* +*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 @@ -683,15 +295,15 @@ Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | -**Returns:** *string* +**Returns:** *[string, string]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData -▸ **getABIDecodedTransactionData**(`callData`: string): *void* +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:259](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L259)* +*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 @@ -701,37 +313,45 @@ Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | -**Returns:** *void* +**Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData -▸ **getABIEncodedTransactionData**(): *string* +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:249](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L249)* +*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 ___ -### ERC20_PROXY_ID +### decodeAssetProxyTransferError -#### ▪ **ERC20_PROXY_ID**: *object* +#### ▪ **decodeAssetProxyTransferError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1008](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1008)* +*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**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1014](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1014)* +*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 @@ -739,18 +359,21 @@ since they don't modify state. **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise`* +**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* +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1073](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1073)* +*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 @@ -760,15 +383,15 @@ Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | -**Returns:** *string* +**Returns:** *[string, string, string]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData -▸ **getABIDecodedTransactionData**(`callData`: string): *void* +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1061](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1061)* +*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 @@ -778,37 +401,45 @@ Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | -**Returns:** *void* +**Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData -▸ **getABIEncodedTransactionData**(): *string* +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1051](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1051)* +*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 ___ -### ERC721_PROXY_ID +### decodeEIP1271SignatureError -#### ▪ **ERC721_PROXY_ID**: *object* +#### ▪ **decodeEIP1271SignatureError**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1499](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1499)* +*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**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1505](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1505)* +*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 @@ -816,18 +447,21 @@ since they don't modify state. **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`encoded` | string | - | ABI-encoded revert error. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise`* +**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* +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, string, string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1564](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1564)* +*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 @@ -837,15 +471,15 @@ Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | -**Returns:** *string* +**Returns:** *[string, string, string, string]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData -▸ **getABIDecodedTransactionData**(`callData`: string): *void* +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1552](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1552)* +*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 @@ -855,173 +489,25 @@ Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | -**Returns:** *void* +**Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData -▸ **getABIEncodedTransactionData**(): *string* +▸ **getABIEncodedTransactionData**(`encoded`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1542](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1542)* +*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). -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### MULTI_ASSET_PROXY_ID - -#### ▪ **MULTI_ASSET_PROXY_ID**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1660](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1660)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1666](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1666)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1725](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1725)* - -Decode the ABI-encoded return data from a transaction - **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1713](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1713)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1703](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1703)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### STATIC_CALL_PROXY_ID - -#### ▪ **STATIC_CALL_PROXY_ID**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2295](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2295)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2301](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2301)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2360](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2360)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2348](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2348)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2338](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2338)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). +`encoded` | string | ABI-encoded revert error. | **Returns:** *string* @@ -1033,7 +519,7 @@ ___ #### ▪ **decodeERC1155AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1336](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1336)* +*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. @@ -1041,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:1345](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1345)* +*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 @@ -1063,7 +549,7 @@ The ERC-1155 AssetProxy identifier, the address of the ERC-1155 contract hosting ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`[], `BigNumber`[], string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1404](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1404)* +*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 @@ -1081,7 +567,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1392](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1392)* +*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 @@ -1099,7 +585,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`assetData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1381](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1381)* +*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 @@ -1121,7 +607,7 @@ ___ #### ▪ **decodeERC20AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1084](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1084)* +*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. @@ -1129,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:1092](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1092)* +*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 @@ -1151,7 +637,7 @@ The ERC-20 AssetProxy identifier, and the address of the ERC-20 contract hostin ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1148](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1148)* +*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 @@ -1169,7 +655,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1136)* +*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 @@ -1187,7 +673,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`assetData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1125](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1125)* +*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 @@ -1209,7 +695,7 @@ ___ #### ▪ **decodeERC721AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L34)* +*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. @@ -1217,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:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L43)* +*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 @@ -1239,7 +725,7 @@ The ERC-721 AssetProxy identifier, the address of the ERC-721 contract hosting t ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:100](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L100)* +*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 @@ -1257,7 +743,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L88)* +*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 @@ -1275,7 +761,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`assetData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:77](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L77)* +*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 @@ -1293,11 +779,275 @@ 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:1937](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1937)* +*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. @@ -1305,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:1945](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1945)* +*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 @@ -1327,7 +1077,7 @@ The Multi-Asset AssetProxy identifier, an array of the amounts of the assets to ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, `BigNumber`[], string[]]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2001](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2001)* +*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 @@ -1345,7 +1095,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1989](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1989)* +*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 @@ -1363,7 +1113,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`assetData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1978](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1978)* +*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 @@ -1381,11 +1131,715 @@ 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:559](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L559)* +*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. @@ -1393,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:568](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L568)* +*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 @@ -1415,7 +1869,7 @@ The name of the function called, and the parameters it was given. For singl ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, `Array`, `BigNumber`[], string[]]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L667)* +*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 @@ -1433,7 +1887,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:655](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L655)* +*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 @@ -1451,7 +1905,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`transactionData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:642](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L642)* +*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 @@ -1473,7 +1927,7 @@ ___ #### ▪ **encodeERC1155AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1736](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1736)* +*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. @@ -1481,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:1749](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1749)* +*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 @@ -1506,7 +1960,7 @@ AssetProxy-compliant asset data describing the set of assets. ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1830](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1830)* +*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 @@ -1524,7 +1978,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1818)* +*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 @@ -1542,7 +1996,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1796](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1796)* +*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 @@ -1567,7 +2021,7 @@ ___ #### ▪ **encodeERC20AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:478](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L478)* +*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. @@ -1575,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:487](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L487)* +*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 @@ -1597,7 +2051,7 @@ AssetProxy-compliant data describing the asset. ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L548)* +*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 @@ -1615,7 +2069,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:536](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L536)* +*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 @@ -1633,7 +2087,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`tokenAddress`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:523](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L523)* +*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 @@ -1655,7 +2109,7 @@ ___ #### ▪ **encodeERC721AssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1575](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1575)* +*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. @@ -1663,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:1585](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1585)* +*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 @@ -1686,7 +2140,7 @@ AssetProxy-compliant asset data describing the asset. ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1652](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1652)* +*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 @@ -1704,7 +2158,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1640](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1640)* +*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 @@ -1722,7 +2176,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1625](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1625)* +*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 @@ -1745,7 +2199,7 @@ ___ #### ▪ **encodeMultiAssetData**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2210](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2210)* +*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. @@ -1753,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:2220](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2220)* +*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 @@ -1776,7 +2230,7 @@ AssetProxy-compliant data describing the set of assets. ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2287](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2287)* +*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 @@ -1794,7 +2248,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2275](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2275)* +*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 @@ -1812,7 +2266,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2260](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2260)* +*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 @@ -1835,7 +2289,7 @@ ___ #### ▪ **getAssetProxyAllowance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2112)* +*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. @@ -1843,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:2122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2122)* +*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 @@ -1866,7 +2320,7 @@ Number of assets (or asset baskets) that the corresponding AssetProxy is authori ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2199](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2199)* +*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 @@ -1884,7 +2338,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2187](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2187)* +*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 @@ -1902,7 +2356,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2172](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2172)* +*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 @@ -1925,7 +2379,7 @@ ___ #### ▪ **getBalance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:718](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L718)* +*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. @@ -1933,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:728](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L728)* +*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 @@ -1956,7 +2410,7 @@ Number of assets (or asset baskets) held by owner. ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:805](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L805)* +*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 @@ -1974,7 +2428,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:793](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L793)* +*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 @@ -1992,7 +2446,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:778](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L778)* +*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 @@ -2015,7 +2469,7 @@ ___ #### ▪ **getBalanceAndAssetProxyAllowance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:111](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L111)* +*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. @@ -2023,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:121](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L121)* +*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 @@ -2046,7 +2500,7 @@ Number of assets (or asset baskets) held by owner, and number of assets (or asse ▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:198](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L198)* +*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 @@ -2064,7 +2518,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:186](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L186)* +*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 @@ -2082,7 +2536,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:171](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L171)* +*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 @@ -2105,7 +2559,7 @@ ___ #### ▪ **getBatchAssetProxyAllowances**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:380](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L380)* +*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. @@ -2113,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:390](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L390)* +*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 @@ -2136,7 +2590,7 @@ An array of asset allowances from getAllowance(), with each element correspondin ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:467](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L467)* +*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 @@ -2154,7 +2608,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:455](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L455)* +*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 @@ -2172,7 +2626,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:440](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L440)* +*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 @@ -2195,7 +2649,7 @@ ___ #### ▪ **getBatchBalances**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2014](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2014)* +*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. @@ -2203,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:2024](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2024)* +*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 @@ -2226,7 +2680,7 @@ Array of asset balances from getBalance(), with each element corresponding to th ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2101](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2101)* +*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 @@ -2244,7 +2698,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2089](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2089)* +*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 @@ -2262,7 +2716,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2074](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2074)* +*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 @@ -2285,7 +2739,7 @@ ___ #### ▪ **getBatchBalancesAndAssetProxyAllowances**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2371](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2371)* +*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. @@ -2293,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:2381](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2381)* +*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 @@ -2316,7 +2770,7 @@ An array of asset balances from getBalance(), and an array of asset allowances f ▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`[], `BigNumber`[]]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2458](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2458)* +*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 @@ -2334,7 +2788,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string[]]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2446](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2446)* +*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 @@ -2352,7 +2806,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2431](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2431)* +*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 @@ -2371,101 +2825,11 @@ The ABI encoded transaction data as a string ___ -### getERC721TokenOwner - -#### ▪ **getERC721TokenOwner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1841](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1841)* - -Calls `asset.ownerOf(tokenId)`, but returns a null owner instead of reverting on an unowned asset. - -#### callAsync - -▸ **callAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1850](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1850)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | Address of ERC721 asset. | -`tokenId` | `BigNumber` | - | The identifier for the specific NFT. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Owner of tokenId or null address if unowned. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1926](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1926)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1914](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1914)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1899)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`tokenAddress` | string | Address of ERC721 asset. | -`tokenId` | `BigNumber` | The identifier for the specific NFT. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - ### getEthBalances #### ▪ **getEthBalances**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1417)* +*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 @@ -2473,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:1425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1425)* +*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 @@ -2495,7 +2859,7 @@ Array of ETH balances. ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1491](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1491)* +*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 @@ -2513,7 +2877,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1479](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1479)* +*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 @@ -2531,7 +2895,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`addresses`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1468](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1468)* +*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 @@ -2553,7 +2917,7 @@ ___ #### ▪ **getOrderRelevantState**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1159](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1159)* +*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. @@ -2561,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:1170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1170)* +*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 @@ -2584,7 +2948,7 @@ The orderInfo (hash, status, and `takerAssetAmount` already filled for ▸ **getABIDecodedReturnData**(`returnData`: string): *[object, `BigNumber`, boolean]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1319](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1319)* +*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 @@ -2602,7 +2966,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1269](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1269)* +*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 @@ -2620,7 +2984,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`order`: object, `signature`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1239](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1239)* +*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 @@ -2643,7 +3007,7 @@ ___ #### ▪ **getOrderRelevantStates**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:816](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L816)* +*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. @@ -2651,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:827](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L827)* +*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 @@ -2674,7 +3038,7 @@ The ordersInfo (array of the hash, status, and `takerAssetAmount` alre ▸ **getABIDecodedReturnData**(`returnData`: string): *[`Array`, `BigNumber`[], boolean[]]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:986](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L986)* +*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 @@ -2692,7 +3056,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[]]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:936](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L936)* +*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 @@ -2710,7 +3074,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:905](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L905)* +*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 @@ -2729,11 +3093,363 @@ 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:282](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L282)* +*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. @@ -2741,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:292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L292)* +*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 @@ -2758,13 +3474,13 @@ Name | Type | Default | Description | **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`. +The amount of the asset tranferable by the owner. NOTE: If the `assetData` encodes data for multiple assets, the `transferableAssetAmount` will represent the amount of times the entire `assetData` can be transferred. To calculate the total individual transferable amounts, this scaled `transferableAmount` must be multiplied by the individual asset amounts located within the `assetData`. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:369](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L369)* +*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 @@ -2782,7 +3498,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:357](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L357)* +*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 @@ -2800,7 +3516,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:342](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L342)* +*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 @@ -2819,7392 +3535,6 @@ The ABI encoded transaction data as a string
-# Class: DummyERC20TokenContract - - -## Constructors - - - -\+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2321)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* - -## Properties - -#### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2305](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2305)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents) | The DummyERC20Token contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2263](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2263)* - -Subscribe to an event type emitted by the DummyERC20Token contract. - -**Type parameters:** - -▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents) | - | The DummyERC20Token contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2288](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2288)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2294](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2294)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1934](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1934)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1884](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1884)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | -`_decimals` | `BigNumber` | -`_totalSupply` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1845](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1845)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | -`_decimals` | `BigNumber` | -`_totalSupply` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### MAX_MINT_AMOUNT - -#### ▪ **MAX_MINT_AMOUNT**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1771](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1771)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1777](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1777)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1836](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1836)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *`BigNumber`* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1824](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1824)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1814](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1814)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### allowance - -#### ▪ **allowance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1312](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1312)* - -#### callAsync - -▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1321)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_owner` | string | - | The address of the account owning tokens | -`_spender` | string | - | The address of the account able to transfer the tokens | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Amount of remaining tokens allowed to spent - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1397](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1397)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *`BigNumber`* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1385](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1385)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1370](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1370)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | The address of the account owning tokens | -`_spender` | string | The address of the account able to transfer the tokens | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### approve - -#### ▪ **approve**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:133](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L133)* - -`msg.sender` approves `_spender` to spend `_value` tokens - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:179](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L179)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_spender` | string | The address of the account able to transfer the tokens | -`_value` | `BigNumber` | The amount of wei to be approved for transfer | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:253](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L253)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_spender` | string | - | The address of the account able to transfer the tokens | -`_value` | `BigNumber` | - | The amount of wei to be approved for transfer | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Always true if the call has enough gas to complete execution - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:209](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L209)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_spender` | string | The address of the account able to transfer the tokens | -`_value` | `BigNumber` | The amount of wei to be approved for transfer | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L329)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *boolean* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:317](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L317)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:302](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L302)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_spender` | string | The address of the account able to transfer the tokens | -`_value` | `BigNumber` | The amount of wei to be approved for transfer | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L142)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_spender` | string | The address of the account able to transfer the tokens | -`_value` | `BigNumber` | The amount of wei to be approved for transfer | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:236](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L236)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_spender` | string | -`_value` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### balanceOf - -#### ▪ **balanceOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:721](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L721)* - -Query the balance of owner - -#### callAsync - -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:729](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L729)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_owner` | string | - | The address from which the balance will be retrieved | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Balance of owner - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:795](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L795)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *`BigNumber`* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:783](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L783)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:772](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L772)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | The address from which the balance will be retrieved | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### decimals - -#### ▪ **decimals**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:645](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L645)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:651](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L651)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:710](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L710)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *`BigNumber`* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:698](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L698)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:688](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L688)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### mint - -#### ▪ **mint**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:952](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L952)* - -Mints new tokens for sender - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:988](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L988)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_value` | `BigNumber` | Amount of tokens to mint | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1048](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1048)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_value` | `BigNumber` | - | Amount of tokens to mint | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1015](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1015)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_value` | `BigNumber` | Amount of tokens to mint | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1110](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1110)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1098](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1098)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[`BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1087](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1087)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_value` | `BigNumber` | Amount of tokens to mint | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:960](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L960)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_value` | `BigNumber` | Amount of tokens to mint | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1034](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1034)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_value` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### name - -#### ▪ **name**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L57)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L63)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L122)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:110](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L110)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:100](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L100)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:803](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L803)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:809](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L809)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:868](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L868)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:856](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L856)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:846](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L846)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### setBalance - -#### ▪ **setBalance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1408](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1408)* - -Sets the balance of target address - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1454](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1454)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_target` | string | Address or which balance will be updated | -`_value` | `BigNumber` | New balance of target address | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_target`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1527](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1527)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_target` | string | - | Address or which balance will be updated | -`_value` | `BigNumber` | - | New balance of target address | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1484](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1484)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_target` | string | Address or which balance will be updated | -`_value` | `BigNumber` | New balance of target address | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1603](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1603)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1591](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1591)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_target`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1576](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1576)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_target` | string | Address or which balance will be updated | -`_value` | `BigNumber` | New balance of target address | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1417)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_target` | string | Address or which balance will be updated | -`_value` | `BigNumber` | New balance of target address | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1511](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1511)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_target` | string | -`_value` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### symbol - -#### ▪ **symbol**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:876](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L876)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:882](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L882)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:941](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L941)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:929](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L929)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:919](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L919)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### totalSupply - -#### ▪ **totalSupply**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:340](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L340)* - -Query total supply of token - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:347](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L347)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -Total supply of token - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:406](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L406)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *`BigNumber`* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:394](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L394)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:384](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L384)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### transfer - -#### ▪ **transfer**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1121](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1121)* - -send `value` token to `to` from `msg.sender` - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1164](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1164)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | The address of the recipient | -`_value` | `BigNumber` | The amount of token to be transferred | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1231](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1231)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | The address of the recipient | -`_value` | `BigNumber` | - | The amount of token to be transferred | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -True if transfer was successful - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1194](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1194)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | The address of the recipient | -`_value` | `BigNumber` | The amount of token to be transferred | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1304](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1304)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *boolean* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1292)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1277](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1277)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | The address of the recipient | -`_value` | `BigNumber` | The amount of token to be transferred | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1130)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | The address of the recipient | -`_value` | `BigNumber` | The amount of token to be transferred | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1214)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_to` | string | -`_value` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### transferFrom - -#### ▪ **transferFrom**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L417)* - -ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. See https://github.com/ethereum/EIPs/issues/717 - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:468](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L468)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:555](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L555)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | Address to transfer from. | -`_to` | string | - | Address to transfer to. | -`_value` | `BigNumber` | - | Amount to transfer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Success of transfer. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:506](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L506)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L637)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *boolean* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:625](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L625)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:608](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L608)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L427)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:536](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L536)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_from` | string | -`_to` | string | -`_value` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1611](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1611)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1645](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1645)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1700](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1700)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`newOwner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1671](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1671)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1763](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1763)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1751)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1738](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1738)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1618](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1618)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1690](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1690)* - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -
- -# Class: DummyERC721TokenContract - - -## Constructors - - - -\+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2860)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* - -## Properties - -#### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2844](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2844)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents) | The DummyERC721Token contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2802](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2802)* - -Subscribe to an event type emitted by the DummyERC721Token contract. - -**Type parameters:** - -▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents) | - | The DummyERC721Token contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2827](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2827)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2833](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2833)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2425)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2377](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2377)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2342](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2342)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### approve - -#### ▪ **approve**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:230](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L230)* - -The zero address indicates there is no approved address. -Throws unless `msg.sender` is the current NFT owner, or an authorized -operator of the current owner. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:276](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L276)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_approved` | string | The new approved NFT controller | -`_tokenId` | `BigNumber` | The NFT to approve | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:349](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L349)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_approved` | string | - | The new approved NFT controller | -`_tokenId` | `BigNumber` | - | The NFT to approve | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:306](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L306)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_approved` | string | The new approved NFT controller | -`_tokenId` | `BigNumber` | The NFT to approve | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L425)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:413](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L413)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:398](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L398)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_approved` | string | The new approved NFT controller | -`_tokenId` | `BigNumber` | The NFT to approve | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:239](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L239)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_approved` | string | The new approved NFT controller | -`_tokenId` | `BigNumber` | The NFT to approve | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:333](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L333)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_approved` | string | -`_tokenId` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### balanceOf - -#### ▪ **balanceOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1185](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1185)* - -NFTs assigned to the zero address are considered invalid, and this -function throws for queries about the zero address. - -#### callAsync - -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1193](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1193)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_owner` | string | - | An address for whom to query the balance | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -The number of NFTs owned by `_owner`, possibly zero - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1259](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1259)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *`BigNumber`* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1247](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1247)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1236](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1236)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | An address for whom to query the balance | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### burn - -#### ▪ **burn**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1417)* - -Function to burn a token -Reverts if the given token ID doesn't exist or not called by contract owner - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1460](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1460)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | Owner of token with given token ID | -`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1530](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1530)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_owner` | string | - | Owner of token with given token ID | -`_tokenId` | `BigNumber` | - | ID of the token to be burned by the msg.sender | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1490](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1490)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | Owner of token with given token ID | -`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1603](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1603)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1591](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1591)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1576](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1576)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | Owner of token with given token ID | -`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1426)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | Owner of token with given token ID | -`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1514](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1514)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_owner` | string | -`_tokenId` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### getApproved - -#### ▪ **getApproved**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:143](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L143)* - -Throws if `_tokenId` is not a valid NFT. - -#### callAsync - -▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:151](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L151)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_tokenId` | `BigNumber` | - | The NFT to find the approved address for | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -The approved address for this NFT, or the zero address if there is none - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L217)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:205](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L205)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *`BigNumber`* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:194](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L194)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_tokenId` | `BigNumber` | The NFT to find the approved address for | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### isApprovedForAll - -#### ▪ **isApprovedForAll**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2088](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2088)* - -#### callAsync - -▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2097](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2097)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_owner` | string | - | The address that owns the NFTs | -`_operator` | string | - | The address that acts on behalf of the owner | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -True if `_operator` is an approved operator for `_owner`, false otherwise - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2173](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2173)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *boolean* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2161](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2161)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2146](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2146)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | The address that owns the NFTs | -`_operator` | string | The address that acts on behalf of the owner | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### mint - -#### ▪ **mint**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:670](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L670)* - -Function to mint a new token -Reverts if the given token ID already exists - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:713](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L713)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | Address of the beneficiary that will own the minted token | -`_tokenId` | `BigNumber` | ID of the token to be minted by the msg.sender | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:783](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L783)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | Address of the beneficiary that will own the minted token | -`_tokenId` | `BigNumber` | - | ID of the token to be minted by the msg.sender | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:743](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L743)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | Address of the beneficiary that will own the minted token | -`_tokenId` | `BigNumber` | ID of the token to be minted by the msg.sender | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:856](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L856)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:844](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L844)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:829](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L829)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | Address of the beneficiary that will own the minted token | -`_tokenId` | `BigNumber` | ID of the token to be minted by the msg.sender | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:679](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L679)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | Address of the beneficiary that will own the minted token | -`_tokenId` | `BigNumber` | ID of the token to be minted by the msg.sender | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:767](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L767)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_to` | string | -`_tokenId` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### name - -#### ▪ **name**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:67](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L67)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L73)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:132](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L132)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:120](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L120)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:110](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L110)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1267](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1267)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1273)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1332](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1332)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1320](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1320)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1310](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1310)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### ownerOf - -#### ▪ **ownerOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1099](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1099)* - -NFTs assigned to zero address are considered invalid, and queries -about them do throw. - -#### callAsync - -▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1107)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_tokenId` | `BigNumber` | - | The identifier for an NFT | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -The address of the owner of the NFT - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1173](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1173)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1161](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1161)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *`BigNumber`* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1150](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1150)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_tokenId` | `BigNumber` | The identifier for an NFT | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### safeTransferFrom1 - -#### ▪ **safeTransferFrom1**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:868](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L868)* - -This works identically to the other function with an extra data parameter, -except this function just sets data to "". - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:919](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L919)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1005](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1005)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | The current owner of the NFT | -`_to` | string | - | The new owner | -`_tokenId` | `BigNumber` | - | The NFT to transfer | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:957](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L957)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1087](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1087)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1075](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1075)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1058](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1058)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:878](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L878)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:987](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L987)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_from` | string | -`_to` | string | -`_tokenId` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### safeTransferFrom2 - -#### ▪ **safeTransferFrom2**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1831](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1831)* - -Throws unless `msg.sender` is the current owner, an authorized -operator, or the approved address for this NFT. Throws if `_from` is -not the current owner. Throws if `_to` is the zero address. Throws if -`_tokenId` is not a valid NFT. When transfer is complete, this function -checks if `_to` is a smart contract (code size > 0). If so, it calls -`onERC721Received` on `_to` and throws if the return value is not -`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1893](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1893)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`_data` | string | Additional data with no specified format, sent in call to `_to` | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1994](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1994)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | The current owner of the NFT | -`_to` | string | - | The new owner | -`_tokenId` | `BigNumber` | - | The NFT to transfer | -`_data` | string | - | Additional data with no specified format, sent in call to `_to` | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1935](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1935)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`_data` | string | Additional data with no specified format, sent in call to `_to` | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2080](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2080)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`, string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2068](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2068)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, string, `BigNumber`, string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2051](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2051)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`_data` | string | Additional data with no specified format, sent in call to `_to` | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1842](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1842)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`_data` | string | Additional data with no specified format, sent in call to `_to` | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1968](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1968)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_from` | string | -`_to` | string | -`_tokenId` | `BigNumber` | -`_data` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### setApprovalForAll - -#### ▪ **setApprovalForAll**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1615](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1615)* - -Emits the ApprovalForAll event. The contract MUST allow -multiple operators per owner. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1661](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1661)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_operator` | string | Address to add to the set of authorized operators | -`_approved` | boolean | True if the operator is approved, false to revoke approval | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_operator`: string, `_approved`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1738](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1738)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_operator` | string | - | Address to add to the set of authorized operators | -`_approved` | boolean | - | True if the operator is approved, false to revoke approval | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1695](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1695)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_operator` | string | Address to add to the set of authorized operators | -`_approved` | boolean | True if the operator is approved, false to revoke approval | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1814](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1814)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1802](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1802)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, boolean]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1787](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1787)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_operator` | string | Address to add to the set of authorized operators | -`_approved` | boolean | True if the operator is approved, false to revoke approval | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1624](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1624)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_operator` | string | Address to add to the set of authorized operators | -`_approved` | boolean | True if the operator is approved, false to revoke approval | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1722](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1722)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_operator` | string | -`_approved` | boolean | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### symbol - -#### ▪ **symbol**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1340](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1340)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1346](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1346)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1405](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1405)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1393](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1393)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1383)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### transferFrom - -#### ▪ **transferFrom**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:439](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L439)* - -Throws unless `msg.sender` is the current owner, an authorized -operator, or the approved address for this NFT. Throws if `_from` is -not the current owner. Throws if `_to` is the zero address. Throws if -`_tokenId` is not a valid NFT. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:490](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L490)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:576](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L576)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | The current owner of the NFT | -`_to` | string | - | The new owner | -`_tokenId` | `BigNumber` | - | The NFT to transfer | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:528](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L528)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:658](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L658)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:646](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L646)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:629](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L629)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:449](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L449)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:558](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L558)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_from` | string | -`_to` | string | -`_tokenId` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2181)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2215](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2215)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2270](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2270)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`newOwner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2241](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2241)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2333](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2333)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2321)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2308](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2308)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2188](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2188)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2260](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2260)* - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -
- -# Class: DutchAuctionContract - - -## Constructors - - - -\+ **new DutchAuctionContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DutchAuctionContract](#class-dutchauctioncontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:1248](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L1248)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[DutchAuctionContract](#class-dutchauctioncontract)* - -## Properties - -#### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:956](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L956)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:909](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L909)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:876](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L876)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### getAuctionDetails - -#### ▪ **getAuctionDetails**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L34)* - -Calculates the Auction Details for the given order - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L88)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | The sell order | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L192)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The sell order | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -AuctionDetails - -#### estimateGasAsync - -▸ **estimateGasAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:127](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L127)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | The sell order | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:334](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L334)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *object* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L292)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *object* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:266](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L266)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | The sell order | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L42)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | The sell order | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:164](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L164)* - -**Parameters:** - -Name | Type | ------- | ------ | -`order` | object | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### matchOrders - -#### ▪ **matchOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:377](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L377)* - -Matches the buy and sell orders at an amount given the following: the current block time, the auction -start time and the auction begin amount. The sell order is a an order at the lowest amount -at the end of the auction. Excess from the match is transferred to the seller. -Over time the price moves from beginAmount to endAmount given the current block.timestamp. -sellOrder.expiryTimeSeconds is the end time of the auction. -sellOrder.takerAssetAmount is the end amount of the auction (lowest possible amount). -sellOrder.makerAssetData is the ABI encoded Asset Proxy data with the following data appended -buyOrder.makerAssetData is the buyers bid on the auction, must meet the amount for the current block timestamp -(uint256 beginTimeSeconds, uint256 beginAmount). -This function reverts in the following scenarios: -* Auction has not started (auctionDetails.currentTimeSeconds < auctionDetails.beginTimeSeconds) -* Auction has expired (auctionDetails.endTimeSeconds < auctionDetails.currentTimeSeconds) -* Amount is invalid: Buy order amount is too low (buyOrder.makerAssetAmount < auctionDetails.currentAmount) -* Amount is invalid: Invalid begin amount (auctionDetails.beginAmount > auctionDetails.endAmount) -* Any failure in the 0x Match Orders - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:459](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L459)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | -`sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | -`buySignature` | string | Proof that order was created by the buyer. | -`sellSignature` | string | Proof that order was created by the seller. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L637)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`buyOrder` | object | - | The Buyer's order. This order is for the current expected price of the auction. | -`sellOrder` | object | - | The Seller's order. This order is for the lowest amount (at the end of the auction). | -`buySignature` | string | - | Proof that order was created by the buyer. | -`sellSignature` | string | - | Proof that order was created by the seller. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -matchedFillResults amounts filled and fees paid by maker and taker of matched orders. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:527](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L527)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | -`sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | -`buySignature` | string | Proof that order was created by the buyer. | -`sellSignature` | string | Proof that order was created by the seller. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:836](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L836)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *object* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:794](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L794)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *object* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L748)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | -`sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | -`buySignature` | string | Proof that order was created by the buyer. | -`sellSignature` | string | Proof that order was created by the seller. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:390](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L390)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | -`sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | -`buySignature` | string | Proof that order was created by the buyer. | -`sellSignature` | string | Proof that order was created by the seller. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:582](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L582)* - -**Parameters:** - -Name | Type | ------- | ------ | -`buyOrder` | object | -`sellOrder` | object | -`buySignature` | string | -`sellSignature` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -
- -# Class: ERC1155ProxyContract - - -## Constructors - - - -\+ **new ERC1155ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC1155ProxyContract](#class-erc1155proxycontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1744](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1744)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ERC1155ProxyContract](#class-erc1155proxycontract)* - -## Properties - -#### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC1155ProxyEvents](#enumeration-erc1155proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1728](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1728)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[ERC1155ProxyEventArgs](#erc1155proxyeventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [ERC1155ProxyEvents](#enumeration-erc1155proxyevents) | The ERC1155Proxy contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [ERC1155ProxyEvents](#enumeration-erc1155proxyevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1686](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1686)* - -Subscribe to an event type emitted by the ERC1155Proxy contract. - -**Type parameters:** - -▪ **ArgsType**: *[ERC1155ProxyEventArgs](#erc1155proxyeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [ERC1155ProxyEvents](#enumeration-erc1155proxyevents) | - | The ERC1155Proxy contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1711](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1711)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1717](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1717)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1470](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1470)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1428)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1403](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1403)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### addAuthorizedAddress - -#### ▪ **addAuthorizedAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L60)* - -Authorizes an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L96)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:153](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L153)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to authorize. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L123)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L217)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:205](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L205)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L192)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L68)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L142)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### authorities - -#### ▪ **authorities**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L225)* - -#### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:231](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L231)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:296](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L296)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:284](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L284)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *`BigNumber`* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L273)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`index_0` | `BigNumber` | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### authorized - -#### ▪ **authorized**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1084](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1084)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1090](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1090)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1157](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1157)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *boolean* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1145](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1145)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1132](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1132)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`index_0` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getAuthorizedAddresses - -#### ▪ **getAuthorizedAddresses**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1168)* - -Gets all authorized addresses. - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1175)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -Array of authorized addresses. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1234](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1234)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string[]* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1222](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1222)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1212)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getProxyId - -#### ▪ **getProxyId**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1020](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1020)* - -Gets the proxy id associated with the proxy address. - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1027](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1027)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -Proxy id. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1076](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1076)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1064](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1064)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1054](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1054)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L472)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:478](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L478)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:537](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L537)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:525](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L525)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:515](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L515)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### removeAuthorizedAddress - -#### ▪ **removeAuthorizedAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:307](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L307)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:343](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L343)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:400](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L400)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:370](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L370)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:464](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L464)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:452](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L452)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:439](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L439)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:315](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L315)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:389](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L389)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### removeAuthorizedAddressAtIndex - -#### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L548)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:594](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L594)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`target`: string, `index`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:675](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L675)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`index` | `BigNumber` | - | Index of target in authorities array. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:628](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L628)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L751)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:739](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L739)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:724](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L724)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L557)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:655](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L655)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`index` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### transferFrom - -#### ▪ **transferFrom**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:762](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L762)* - -Transfers batch of ERC1155 assets. Either succeeds or throws. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:822](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L822)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | -`from` | string | Address to transfer assets from. | -`to` | string | Address to transfer assets to. | -`amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:921](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L921)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | -`from` | string | - | Address to transfer assets from. | -`to` | string | - | Address to transfer assets to. | -`amount` | `BigNumber` | - | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:866](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L866)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | -`from` | string | Address to transfer assets from. | -`to` | string | Address to transfer assets to. | -`amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1009](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1009)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:997](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L997)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, string, string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:980](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L980)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | -`from` | string | Address to transfer assets from. | -`to` | string | Address to transfer assets to. | -`amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:775](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L775)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | -`from` | string | Address to transfer assets from. | -`to` | string | Address to transfer assets to. | -`amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L899)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`from` | string | -`to` | string | -`amount` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1242](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1242)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1276](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1276)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1331](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1331)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`newOwner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1302](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1302)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1394](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1394)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1382](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1382)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1369](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1369)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1249](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1249)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1321)* - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -
- -# Class: ERC20ProxyContract - - -## Constructors - - - -\+ **new ERC20ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC20ProxyContract](#class-erc20proxycontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1467](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1467)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ERC20ProxyContract](#class-erc20proxycontract)* - -## Properties - -#### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#enumeration-erc20proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1451](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1451)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[ERC20ProxyEventArgs](#erc20proxyeventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [ERC20ProxyEvents](#enumeration-erc20proxyevents) | The ERC20Proxy contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#enumeration-erc20proxyevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1409](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1409)* - -Subscribe to an event type emitted by the ERC20Proxy contract. - -**Type parameters:** - -▪ **ArgsType**: *[ERC20ProxyEventArgs](#erc20proxyeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [ERC20ProxyEvents](#enumeration-erc20proxyevents) | - | The ERC20Proxy contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1434](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1434)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1440](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1440)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1212)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1170)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1145](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1145)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### addAuthorizedAddress - -#### ▪ **addAuthorizedAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L60)* - -Authorizes an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L96)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:153](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L153)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to authorize. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L123)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L217)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:205](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L205)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L192)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L68)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L142)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### authorities - -#### ▪ **authorities**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L225)* - -#### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:231](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L231)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:296](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L296)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:284](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L284)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *`BigNumber`* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L273)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`index_0` | `BigNumber` | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### authorized - -#### ▪ **authorized**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:826](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L826)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:832](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L832)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L899)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *boolean* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:887](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L887)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:874](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L874)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`index_0` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getAuthorizedAddresses - -#### ▪ **getAuthorizedAddresses**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:910](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L910)* - -Gets all authorized addresses. - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:917](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L917)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -Array of authorized addresses. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:976](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L976)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string[]* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:964](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L964)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:954](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L954)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getProxyId - -#### ▪ **getProxyId**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:762](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L762)* - -Gets the proxy id associated with the proxy address. - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:769](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L769)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -Proxy id. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L818)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:806](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L806)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:796](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L796)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L472)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:478](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L478)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:537](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L537)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:525](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L525)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:515](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L515)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### removeAuthorizedAddress - -#### ▪ **removeAuthorizedAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:307](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L307)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:343](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L343)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:400](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L400)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:370](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L370)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:464](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L464)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:452](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L452)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:439](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L439)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:315](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L315)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:389](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L389)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### removeAuthorizedAddressAtIndex - -#### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L548)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:594](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L594)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`target`: string, `index`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:675](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L675)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`index` | `BigNumber` | - | Index of target in authorities array. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:628](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L628)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L751)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:739](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L739)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:724](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L724)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L557)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:655](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L655)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`index` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:984](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L984)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1018](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1018)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1073](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1073)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`newOwner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1044](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1044)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1136)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1124)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1111](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1111)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:991](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L991)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1063](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1063)* - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -
- # Class: ERC20TokenContract @@ -10212,20 +3542,21 @@ Name | Type | -\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC20TokenContract](#class-erc20tokencontract)* +\+ **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:1259](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1259)* +*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 | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC20TokenContract.deployedBytecode | **Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* @@ -10237,7 +3568,7 @@ Name | Type | -Defined in base-contract/lib/src/index.d.ts:25 +Defined in base-contract/lib/src/index.d.ts:27 ___ @@ -10247,7 +3578,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:26 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -10257,7 +3588,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -10267,7 +3598,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +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 @@ -10277,7 +3616,7 @@ Defined in base-contract/lib/src/index.d.ts:27 -Defined in base-contract/lib/src/index.d.ts:38 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -10293,7 +3632,7 @@ ___ ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1243](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1243)* +*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 @@ -10319,7 +3658,7 @@ ___ ▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1201](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1201)* +*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. @@ -10347,7 +3686,7 @@ ___ ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1226](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1226)* +*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 @@ -10365,7 +3704,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1232](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1232)* +*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 @@ -10377,7 +3716,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1012](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1012)* +*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)* @@ -10389,7 +3728,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:970](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L970)* +*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:** @@ -10409,7 +3748,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:945](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L945)* +*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:** @@ -10430,7 +3769,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:37 +Defined in base-contract/lib/src/index.d.ts:41 **Parameters:** @@ -10447,13 +3786,13 @@ Name | Type | #### ▪ **allowance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:851](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L851)* +*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:860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L860)* +*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 @@ -10476,7 +3815,7 @@ Amount of remaining tokens allowed to spent ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:936](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L936)* +*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 @@ -10494,7 +3833,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:924](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L924)* +*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 @@ -10512,7 +3851,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:909](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L909)* +*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 @@ -10535,7 +3874,7 @@ ___ #### ▪ **approve**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L60)* +*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 @@ -10543,7 +3882,7 @@ ___ ▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:106](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L106)* +*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. @@ -10566,7 +3905,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:180](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L180)* +*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 @@ -10589,7 +3928,7 @@ Always true if the call has enough gas to complete execution ▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L136)* +*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. @@ -10609,7 +3948,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L256)* +*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 @@ -10627,7 +3966,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:244](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L244)* +*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 @@ -10645,7 +3984,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:229](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L229)* +*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 @@ -10666,7 +4005,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:69](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L69)* +*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. @@ -10687,7 +4026,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:163](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L163)* +*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:** @@ -10705,7 +4044,7 @@ ___ #### ▪ **balanceOf**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:575](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L575)* +*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 @@ -10713,7 +4052,7 @@ Query the balance of owner ▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:583](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L583)* +*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 @@ -10735,7 +4074,7 @@ Balance of owner ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:649](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L649)* +*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 @@ -10753,7 +4092,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L637)* +*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 @@ -10771,7 +4110,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_owner`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:626](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L626)* +*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 @@ -10793,7 +4132,7 @@ ___ #### ▪ **totalSupply**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:267](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L267)* +*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 @@ -10801,7 +4140,7 @@ Query total supply of token ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:274](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L274)* +*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 @@ -10822,7 +4161,7 @@ Total supply of token ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:333](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L333)* +*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 @@ -10840,7 +4179,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L321)* +*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 @@ -10858,7 +4197,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:311](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L311)* +*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 @@ -10874,7 +4213,7 @@ ___ #### ▪ **transfer**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:660](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L660)* +*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` @@ -10882,7 +4221,7 @@ send `value` token to `to` from `msg.sender` ▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:703](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L703)* +*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. @@ -10905,7 +4244,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:770](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L770)* +*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 @@ -10928,7 +4267,7 @@ True if transfer was successful ▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:733](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L733)* +*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. @@ -10948,7 +4287,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:843](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L843)* +*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 @@ -10966,7 +4305,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:831](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L831)* +*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 @@ -10984,7 +4323,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:816](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L816)* +*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 @@ -11005,7 +4344,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:669](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L669)* +*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. @@ -11026,7 +4365,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:753](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L753)* +*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:** @@ -11044,7 +4383,7 @@ ___ #### ▪ **transferFrom**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:344](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L344)* +*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` @@ -11052,7 +4391,7 @@ send `value` token to `to` from `from` on the condition it is approved by `from` ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:395](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L395)* +*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. @@ -11076,7 +4415,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L482)* +*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 @@ -11100,7 +4439,7 @@ True if transfer was successful ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:433](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L433)* +*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. @@ -11121,7 +4460,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:564](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L564)* +*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 @@ -11139,7 +4478,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:552](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L552)* +*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 @@ -11157,7 +4496,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:535](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L535)* +*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 @@ -11179,7 +4518,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:354](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L354)* +*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. @@ -11201,7 +4540,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:463](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L463)* +*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:** @@ -11216,1303 +4555,6 @@ Name | Type |
-# Class: ERC721ProxyContract - - -## Constructors - - - -\+ **new ERC721ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC721ProxyContract](#class-erc721proxycontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1467](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1467)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ERC721ProxyContract](#class-erc721proxycontract)* - -## Properties - -#### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721ProxyEvents](#enumeration-erc721proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1451](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1451)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[ERC721ProxyEventArgs](#erc721proxyeventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [ERC721ProxyEvents](#enumeration-erc721proxyevents) | The ERC721Proxy contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [ERC721ProxyEvents](#enumeration-erc721proxyevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1409](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1409)* - -Subscribe to an event type emitted by the ERC721Proxy contract. - -**Type parameters:** - -▪ **ArgsType**: *[ERC721ProxyEventArgs](#erc721proxyeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [ERC721ProxyEvents](#enumeration-erc721proxyevents) | - | The ERC721Proxy contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1434](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1434)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1440](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1440)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1212)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1170)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1145](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1145)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### addAuthorizedAddress - -#### ▪ **addAuthorizedAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L60)* - -Authorizes an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L96)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:153](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L153)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to authorize. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L123)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L217)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:205](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L205)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L192)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L68)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to authorize. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L142)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### authorities - -#### ▪ **authorities**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L225)* - -#### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:231](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L231)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:296](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L296)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:284](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L284)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *`BigNumber`* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L273)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`index_0` | `BigNumber` | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### authorized - -#### ▪ **authorized**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:826](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L826)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:832](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L832)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L899)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *boolean* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:887](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L887)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:874](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L874)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`index_0` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getAuthorizedAddresses - -#### ▪ **getAuthorizedAddresses**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:910](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L910)* - -Gets all authorized addresses. - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:917](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L917)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -Array of authorized addresses. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:976](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L976)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string[]* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:964](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L964)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:954](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L954)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getProxyId - -#### ▪ **getProxyId**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:762](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L762)* - -Gets the proxy id associated with the proxy address. - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:769](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L769)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -Proxy id. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L818)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:806](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L806)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:796](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L796)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L472)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:478](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L478)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:537](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L537)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:525](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L525)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:515](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L515)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### removeAuthorizedAddress - -#### ▪ **removeAuthorizedAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:307](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L307)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:343](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L343)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:400](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L400)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:370](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L370)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:464](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L464)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:452](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L452)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:439](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L439)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:315](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L315)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:389](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L389)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### removeAuthorizedAddressAtIndex - -#### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L548)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:594](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L594)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`target`: string, `index`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:675](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L675)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`index` | `BigNumber` | - | Index of target in authorities array. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:628](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L628)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L751)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:739](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L739)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:724](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L724)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L557)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | -`index` | `BigNumber` | Index of target in authorities array. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:655](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L655)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`index` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:984](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L984)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1018](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1018)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1073](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1073)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`newOwner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1044](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1044)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1136)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1124)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1111](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1111)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:991](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L991)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1063](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1063)* - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -
- # Class: ERC721TokenContract @@ -12520,20 +4562,21 @@ Name | Type | -\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC721TokenContract](#class-erc721tokencontract)* +\+ **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:1961](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1961)* +*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 | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC721TokenContract.deployedBytecode | **Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* @@ -12545,7 +4588,7 @@ Name | Type | -Defined in base-contract/lib/src/index.d.ts:25 +Defined in base-contract/lib/src/index.d.ts:27 ___ @@ -12555,7 +4598,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:26 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -12565,7 +4608,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -12575,7 +4618,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +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 @@ -12585,7 +4636,7 @@ Defined in base-contract/lib/src/index.d.ts:27 -Defined in base-contract/lib/src/index.d.ts:38 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -12601,7 +4652,7 @@ ___ ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1945](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1945)* +*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 @@ -12627,7 +4678,7 @@ ___ ▸ **subscribe**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1903](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1903)* +*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. @@ -12655,7 +4706,7 @@ ___ ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1928](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1928)* +*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 @@ -12673,7 +4724,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1934](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1934)* +*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 @@ -12685,7 +4736,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1634](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1634)* +*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)* @@ -12697,7 +4748,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1592](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1592)* +*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:** @@ -12717,7 +4768,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1567](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1567)* +*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:** @@ -12738,7 +4789,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:37 +Defined in base-contract/lib/src/index.d.ts:41 **Parameters:** @@ -12755,7 +4806,7 @@ Name | Type | #### ▪ **approve**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:157](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L157)* +*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 @@ -12765,7 +4816,7 @@ operator of the current owner. ▸ **awaitTransactionSuccessAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:203](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L203)* +*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. @@ -12788,7 +4839,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:276](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L276)* +*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 @@ -12809,7 +4860,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:233](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L233)* +*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. @@ -12829,7 +4880,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:352](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L352)* +*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 @@ -12847,7 +4898,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:340](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L340)* +*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 @@ -12865,7 +4916,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:325](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L325)* +*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 @@ -12886,7 +4937,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:166](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L166)* +*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. @@ -12907,7 +4958,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:260](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L260)* +*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:** @@ -12925,7 +4976,7 @@ ___ #### ▪ **balanceOf**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:914](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L914)* +*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. @@ -12934,7 +4985,7 @@ function throws for queries about the zero address. ▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:922](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L922)* +*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 @@ -12956,7 +5007,7 @@ The number of NFTs owned by `_owner`, possibly zero ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:988](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L988)* +*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 @@ -12974,7 +5025,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:976](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L976)* +*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 @@ -12992,7 +5043,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_owner`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:965](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L965)* +*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 @@ -13014,7 +5065,7 @@ ___ #### ▪ **getApproved**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L70)* +*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. @@ -13022,7 +5073,7 @@ Throws if `_tokenId` is not a valid NFT. ▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L78)* +*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 @@ -13044,7 +5095,7 @@ The approved address for this NFT, or the zero address if there is none ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:144](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L144)* +*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 @@ -13062,7 +5113,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:132](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L132)* +*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 @@ -13080,7 +5131,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:121](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L121)* +*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 @@ -13102,13 +5153,13 @@ ___ #### ▪ **isApprovedForAll**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1473](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1473)* +*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:1482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1482)* +*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 @@ -13131,7 +5182,7 @@ True if `_operator` is an approved operator for `_owner`, fa ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1558](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1558)* +*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 @@ -13149,7 +5200,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1546](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1546)* +*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 @@ -13167,7 +5218,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1531](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1531)* +*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 @@ -13190,7 +5241,7 @@ ___ #### ▪ **ownerOf**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L828)* +*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. @@ -13199,7 +5250,7 @@ about them do throw. ▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:836](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L836)* +*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 @@ -13221,7 +5272,7 @@ The address of the owner of the NFT ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:902](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L902)* +*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 @@ -13239,7 +5290,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:890](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L890)* +*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 @@ -13257,7 +5308,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:879](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L879)* +*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 @@ -13279,7 +5330,7 @@ ___ #### ▪ **safeTransferFrom1**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:597](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L597)* +*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 "". @@ -13288,7 +5339,7 @@ except this function just sets data to "". ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:648](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L648)* +*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. @@ -13312,7 +5363,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:734](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L734)* +*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 @@ -13334,7 +5385,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:686](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L686)* +*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. @@ -13355,7 +5406,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:816](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L816)* +*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 @@ -13373,7 +5424,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:804](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L804)* +*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 @@ -13391,7 +5442,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:787](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L787)* +*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 @@ -13413,7 +5464,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:607](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L607)* +*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. @@ -13435,7 +5486,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:716](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L716)* +*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:** @@ -13454,7 +5505,7 @@ ___ #### ▪ **safeTransferFrom2**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1216](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1216)* +*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 @@ -13468,7 +5519,7 @@ checks if `_to` is a smart contract (code size > 0). If so, it calls ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1278](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1278)* +*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. @@ -13493,7 +5544,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1379](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1379)* +*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 @@ -13516,7 +5567,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1320](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1320)* +*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. @@ -13538,7 +5589,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1465](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1465)* +*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 @@ -13556,7 +5607,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`, string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1453](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1453)* +*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 @@ -13574,7 +5625,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1436](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1436)* +*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 @@ -13597,7 +5648,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1227](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1227)* +*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. @@ -13620,7 +5671,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1353](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1353)* +*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:** @@ -13640,7 +5691,7 @@ ___ #### ▪ **setApprovalForAll**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1000](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1000)* +*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. @@ -13649,7 +5700,7 @@ multiple operators per owner. ▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1046](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1046)* +*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. @@ -13672,7 +5723,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_operator`: string, `_approved`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1123)* +*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 @@ -13693,7 +5744,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1080](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1080)* +*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. @@ -13713,7 +5764,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1199](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1199)* +*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 @@ -13731,7 +5782,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1187](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1187)* +*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 @@ -13749,7 +5800,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1172](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1172)* +*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 @@ -13770,7 +5821,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1009](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1009)* +*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. @@ -13791,7 +5842,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1107)* +*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:** @@ -13809,7 +5860,7 @@ ___ #### ▪ **transferFrom**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:366](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L366)* +*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 @@ -13820,7 +5871,7 @@ not the current owner. Throws if `_to` is the zero address. Throws if ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L417)* +*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. @@ -13844,7 +5895,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:503](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L503)* +*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 @@ -13866,7 +5917,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:455](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L455)* +*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. @@ -13887,7 +5938,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:585](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L585)* +*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 @@ -13905,7 +5956,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:573](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L573)* +*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 @@ -13923,7 +5974,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:556](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L556)* +*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 @@ -13945,7 +5996,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:376](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L376)* +*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. @@ -13967,7 +6018,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:485](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L485)* +*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:** @@ -13989,20 +6040,21 @@ Name | Type | -\+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ExchangeContract](#class-exchangecontract)* +\+ **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:9704](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9704)* +*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 | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ExchangeContract.deployedBytecode | **Returns:** *[ExchangeContract](#class-exchangecontract)* @@ -14014,7 +6066,7 @@ Name | Type | -Defined in base-contract/lib/src/index.d.ts:25 +Defined in base-contract/lib/src/index.d.ts:27 ___ @@ -14024,7 +6076,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:26 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -14034,7 +6086,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -14044,7 +6096,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +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 @@ -14054,7 +6114,7 @@ Defined in base-contract/lib/src/index.d.ts:27 -Defined in base-contract/lib/src/index.d.ts:38 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -14070,7 +6130,7 @@ ___ ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9688](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9688)* +*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 @@ -14096,7 +6156,7 @@ ___ ▸ **subscribe**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9646](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9646)* +*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. @@ -14124,7 +6184,7 @@ ___ ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9671](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9671)* +*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 @@ -14142,7 +6202,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9677](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9677)* +*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 @@ -14154,7 +6214,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7661](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7661)* +*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)* @@ -14164,9 +6224,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_zrxAssetData`: string): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7614](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7614)* +*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:** @@ -14177,7 +6237,7 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -`_zrxAssetData` | string | +`chainId` | `BigNumber` | **Returns:** *`Promise`* @@ -14185,9 +6245,9 @@ ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_zrxAssetData`: string): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7581](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7581)* +*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:** @@ -14197,7 +6257,7 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -`_zrxAssetData` | string | +`chainId` | `BigNumber` | **Returns:** *`Promise`* @@ -14209,7 +6269,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:37 +Defined in base-contract/lib/src/index.d.ts:41 **Parameters:** @@ -14222,17 +6282,17 @@ Name | Type | ## Object literals -### EIP712_DOMAIN_HASH +### EIP1271_MAGIC_VALUE -#### ▪ **EIP712_DOMAIN_HASH**: *object* +#### ▪ **EIP1271_MAGIC_VALUE**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6829](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6829)* +*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:6835](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6835)* +*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 @@ -14251,7 +6311,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6894](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6894)* +*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 @@ -14269,7 +6329,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6882](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6882)* +*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 @@ -14287,7 +6347,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6872](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6872)* +*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 @@ -14299,17 +6359,17 @@ The ABI encoded transaction data as a string ___ -### VERSION +### EIP712_EXCHANGE_DOMAIN_HASH -#### ▪ **VERSION**: *object* +#### ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7507](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7507)* +*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:7513](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7513)* +*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 @@ -14328,7 +6388,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7572](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7572)* +*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 @@ -14346,7 +6406,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7560](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7560)* +*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 @@ -14364,84 +6424,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7550](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7550)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### ZRX_ASSET_DATA - -#### ▪ **ZRX_ASSET_DATA**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6383)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6389](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6389)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6448](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6448)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6436](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6436)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6426)* +*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 @@ -14457,13 +6440,13 @@ ___ #### ▪ **allowedValidators**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3783](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3783)* +*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:3789](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3789)* +*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 @@ -14484,7 +6467,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3863](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3863)* +*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 @@ -14502,7 +6485,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3851](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3851)* +*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 @@ -14520,7 +6503,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3836](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3836)* +*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 @@ -14539,103 +6522,19 @@ The ABI encoded transaction data as a string ___ -### assetProxies - -#### ▪ **assetProxies**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1715](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1715)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1721](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1721)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1782](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1782)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1770](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1770)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1759](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1759)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`index_0` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - ### batchCancelOrders #### ▪ **batchCancelOrders**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1793](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1793)* +*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)* -Synchronously cancels multiple orders in a single transaction. +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:1848](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1848)* +*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. @@ -14657,7 +6556,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`orders`: `Array`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1953](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1953)* +*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 @@ -14677,7 +6576,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1888](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1888)* +*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. @@ -14696,7 +6595,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2091](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2091)* +*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 @@ -14714,7 +6613,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2043](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2043)* +*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 @@ -14732,7 +6631,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2014](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2014)* +*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 @@ -14752,7 +6651,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1801](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1801)* +*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. @@ -14772,7 +6671,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1926](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1926)* +*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:** @@ -14785,19 +6684,189 @@ Name | Type | ___ +### 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:2104](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2104)* +*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)* -Synchronously executes multiple calls of fillOrKill. +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:2169](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2169)* +*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. @@ -14819,9 +6888,9 @@ A promise that resolves when the transaction is successful #### callAsync -▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2301](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2301)* +*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 @@ -14837,15 +6906,15 @@ Name | Type | Default | Description | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise>`* -Amounts filled and fees paid by makers and taker. NOTE: makerAssetFilledAmount and takerAssetFilledAmount may include amounts filled of different assets. +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:2221](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2221)* +*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. @@ -14864,9 +6933,9 @@ The hash of the transaction #### getABIDecodedReturnData -▸ **getABIDecodedReturnData**(`returnData`: string): *object* +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2456](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2456)* +*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 @@ -14876,7 +6945,7 @@ Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | -**Returns:** *object* +**Returns:** *`Array`* An array representing the output results in order. Keynames of nested structs are preserved. @@ -14884,7 +6953,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2412](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2412)* +*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 @@ -14902,7 +6971,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2379](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2379)* +*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 @@ -14924,7 +6993,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2115](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2115)* +*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. @@ -14946,7 +7015,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2263](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2263)* +*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:** @@ -14965,15 +7034,15 @@ ___ #### ▪ **batchFillOrders**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L175)* +*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)* -Synchronously executes multiple calls of fillOrder. +Executes multiple calls of fillOrder. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:240](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L240)* +*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. @@ -14995,9 +7064,9 @@ A promise that resolves when the transaction is successful #### callAsync -▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:372](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L372)* +*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 @@ -15013,15 +7082,15 @@ Name | Type | Default | Description | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise>`* -Amounts filled and fees paid by makers and taker. NOTE: makerAssetFilledAmount and takerAssetFilledAmount may include amounts filled of different assets. +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:292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L292)* +*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. @@ -15040,9 +7109,9 @@ The hash of the transaction #### getABIDecodedReturnData -▸ **getABIDecodedReturnData**(`returnData`: string): *object* +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:527](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L527)* +*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 @@ -15052,7 +7121,7 @@ Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | -**Returns:** *object* +**Returns:** *`Array`* An array representing the output results in order. Keynames of nested structs are preserved. @@ -15060,7 +7129,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:483](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L483)* +*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 @@ -15078,7 +7147,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:450](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L450)* +*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 @@ -15100,7 +7169,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:186](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L186)* +*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. @@ -15122,7 +7191,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:334](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L334)* +*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:** @@ -15141,16 +7210,15 @@ ___ #### ▪ **batchFillOrdersNoThrow**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2663](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2663)* +*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)* -Fills an order with specified parameters and ECDSA signature. -Returns false if the transaction would otherwise revert. +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:2728](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2728)* +*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. @@ -15172,9 +7240,9 @@ A promise that resolves when the transaction is successful #### callAsync -▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2860)* +*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 @@ -15190,15 +7258,15 @@ Name | Type | Default | Description | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise>`* -Amounts filled and fees paid by makers and taker. NOTE: makerAssetFilledAmount and takerAssetFilledAmount may include amounts filled of different assets. +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:2780](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2780)* +*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. @@ -15217,9 +7285,9 @@ The hash of the transaction #### getABIDecodedReturnData -▸ **getABIDecodedReturnData**(`returnData`: string): *object* +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3015](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3015)* +*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 @@ -15229,7 +7297,7 @@ Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | -**Returns:** *object* +**Returns:** *`Array`* An array representing the output results in order. Keynames of nested structs are preserved. @@ -15237,7 +7305,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2971](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2971)* +*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 @@ -15255,7 +7323,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2938](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2938)* +*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 @@ -15277,7 +7345,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2674](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2674)* +*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. @@ -15299,7 +7367,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2822](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2822)* +*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:** @@ -15314,20 +7382,21 @@ Name | Type | ___ -### cancelOrder +### batchMatchOrders -#### ▪ **cancelOrder**: *object* +#### ▪ **batchMatchOrders**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5994](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5994)* +*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)* -After calling, the order can not be filled anymore. -Throws if order is invalid or sender does not have permission to cancel. +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**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* +▸ **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:6048](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6048)* +*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. @@ -15336,7 +7405,374 @@ If the transaction was mined, but reverted, an error is thrown. Name | Type | Description | ------ | ------ | ------ | -`order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | +`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 | - | @@ -15349,7 +7785,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6151](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6151)* +*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 @@ -15359,7 +7795,7 @@ since they don't modify state. Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`order` | object | - | Order to cancel. Order must be OrderStatus.FILLABLE. | +`order` | object | - | Order struct containing order specifications. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | @@ -15369,7 +7805,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6087](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6087)* +*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. @@ -15377,7 +7813,7 @@ Estimates the gas cost of sending an Ethereum transaction calling this method wi Name | Type | Description | ------ | ------ | ------ | -`order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | +`order` | object | Order struct containing order specifications. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* @@ -15388,7 +7824,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6285](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6285)* +*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 @@ -15406,7 +7842,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[object]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6237](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6237)* +*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 @@ -15424,7 +7860,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`order`: object): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6211](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6211)* +*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 @@ -15434,7 +7870,7 @@ to create a 0x transaction (see protocol spec for more details). Name | Type | Description | ------ | ------ | ------ | -`order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | +`order` | object | Order struct containing order specifications. | **Returns:** *string* @@ -15444,7 +7880,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6002](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6002)* +*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. @@ -15453,7 +7889,7 @@ Ethereum operation and will cost gas. Name | Type | Description | ------ | ------ | ------ | -`order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | +`order` | object | Order struct containing order specifications. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* @@ -15464,7 +7900,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6124)* +*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:** @@ -15481,7 +7917,7 @@ ___ #### ▪ **cancelOrdersUpTo**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2482)* +*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). @@ -15490,7 +7926,7 @@ and senderAddress equal to msg.sender (or null address if msg.sender == makerAdd ▸ **awaitTransactionSuccessAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2520](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2520)* +*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. @@ -15512,7 +7948,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`targetOrderEpoch`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2582](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2582)* +*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 @@ -15532,7 +7968,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2548)* +*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. @@ -15551,7 +7987,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2651](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2651)* +*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 @@ -15569,7 +8005,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2639](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2639)* +*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 @@ -15587,7 +8023,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`targetOrderEpoch`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2626](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2626)* +*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 @@ -15607,7 +8043,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2491](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2491)* +*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. @@ -15627,7 +8063,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2567](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2567)* +*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:** @@ -15644,13 +8080,13 @@ ___ #### ▪ **cancelled**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:549](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L549)* +*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:555](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L555)* +*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 @@ -15670,7 +8106,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:620](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L620)* +*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 @@ -15688,7 +8124,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:608](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L608)* +*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 @@ -15706,7 +8142,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:597](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L597)* +*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 @@ -15728,13 +8164,13 @@ ___ #### ▪ **currentContextAddress**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7274](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7274)* +*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:7280](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7280)* +*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 @@ -15753,7 +8189,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7339](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7339)* +*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 @@ -15771,7 +8207,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7327](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7327)* +*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 @@ -15789,7 +8225,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7317](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7317)* +*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 @@ -15805,15 +8241,15 @@ ___ #### ▪ **executeTransaction**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5404](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5404)* +*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. +Executes an Exchange method call in the context of signer. #### awaitTransactionSuccessAsync -▸ **awaitTransactionSuccessAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* +▸ **awaitTransactionSuccessAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5460](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5460)* +*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. @@ -15822,10 +8258,8 @@ If the transaction was mined, but reverted, an error is thrown. Name | Type | Description | ------ | ------ | ------ | -`salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | -`signerAddress` | string | Address of transaction signer. | -`data` | string | AbiV2 encoded calldata. | -`signature` | string | Proof of signer transaction by signer. | +`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 | - | @@ -15836,9 +8270,9 @@ A promise that resolves when the transaction is successful #### callAsync -▸ **callAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **callAsync**(`transaction`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5561](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5561)* +*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 @@ -15848,20 +8282,20 @@ since they don't modify state. Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`salt` | `BigNumber` | - | Arbitrary number to ensure uniqueness of transaction hash. | -`signerAddress` | string | - | Address of transaction signer. | -`data` | string | - | AbiV2 encoded calldata. | -`signature` | string | - | Proof of signer transaction by signer. | +`transaction` | object | - | 0x transaction structure. | +`signature` | string | - | Proof that transaction has been signed by signer. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise`* + +ABI encoded return data of the underlying Exchange function call. #### estimateGasAsync -▸ **estimateGasAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* +▸ **estimateGasAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5502](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5502)* +*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. @@ -15869,10 +8303,8 @@ Estimates the gas cost of sending an Ethereum transaction calling this method wi Name | Type | Description | ------ | ------ | ------ | -`salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | -`signerAddress` | string | Address of transaction signer. | -`data` | string | AbiV2 encoded calldata. | -`signature` | string | Proof of signer transaction by signer. | +`transaction` | object | 0x transaction structure. | +`signature` | string | Proof that transaction has been signed by signer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* @@ -15881,9 +8313,9 @@ The hash of the transaction #### getABIDecodedReturnData -▸ **getABIDecodedReturnData**(`returnData`: string): *void* +▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5647](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5647)* +*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 @@ -15893,15 +8325,15 @@ Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | -**Returns:** *void* +**Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData -▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`, string, string, string]* +▸ **getABIDecodedTransactionData**(`callData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5635](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5635)* +*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 @@ -15911,15 +8343,15 @@ Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | -**Returns:** *[`BigNumber`, string, string, string]* +**Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData -▸ **getABIEncodedTransactionData**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string): *string* +▸ **getABIEncodedTransactionData**(`transaction`: object, `signature`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5618](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5618)* +*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 @@ -15929,10 +8361,8 @@ to create a 0x transaction (see protocol spec for more details). Name | Type | Description | ------ | ------ | ------ | -`salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | -`signerAddress` | string | Address of transaction signer. | -`data` | string | AbiV2 encoded calldata. | -`signature` | string | Proof of signer transaction by signer. | +`transaction` | object | 0x transaction structure. | +`signature` | string | Proof that transaction has been signed by signer. | **Returns:** *string* @@ -15940,9 +8370,9 @@ The ABI encoded transaction data as a string #### sendTransactionAsync -▸ **sendTransactionAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* +▸ **sendTransactionAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5415](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5415)* +*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. @@ -15951,10 +8381,8 @@ Ethereum operation and will cost gas. Name | Type | Description | ------ | ------ | ------ | -`salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | -`signerAddress` | string | Address of transaction signer. | -`data` | string | AbiV2 encoded calldata. | -`signature` | string | Proof of signer transaction by signer. | +`transaction` | object | 0x transaction structure. | +`signature` | string | Proof that transaction has been signed by signer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* @@ -15963,17 +8391,15 @@ The hash of the transaction #### validateAndSendTransactionAsync -▸ **validateAndSendTransactionAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* +▸ **validateAndSendTransactionAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5535](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5535)* +*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 | ------ | ------ | -`salt` | `BigNumber` | -`signerAddress` | string | -`data` | string | +`transaction` | object | `signature` | string | `txData?` | `Partial` \| undefined | @@ -15985,7 +8411,7 @@ ___ #### ▪ **fillOrKillOrder**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3204](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3204)* +*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. @@ -15993,7 +8419,7 @@ Fills the input order. Reverts if exact takerAssetFillAmount not filled. ▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3266](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3266)* +*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. @@ -16017,7 +8443,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3393](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3393)* +*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 @@ -16039,7 +8465,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3316](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3316)* +*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. @@ -16060,7 +8486,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3543](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3543)* +*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 @@ -16078,7 +8504,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3501](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3501)* +*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 @@ -16096,7 +8522,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3469](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3469)* +*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 @@ -16118,7 +8544,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3214)* +*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. @@ -16140,7 +8566,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3357](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3357)* +*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:** @@ -16159,7 +8585,7 @@ ___ #### ▪ **fillOrder**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5044](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5044)* +*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. @@ -16167,7 +8593,7 @@ Fills the input order. ▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5106](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5106)* +*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. @@ -16191,7 +8617,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5229](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5229)* +*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 @@ -16215,7 +8641,7 @@ Amounts filled and fees paid by maker and taker. ▸ **estimateGasAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5151](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5151)* +*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. @@ -16236,7 +8662,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5379](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5379)* +*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 @@ -16254,7 +8680,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5337](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5337)* +*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 @@ -16272,7 +8698,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5305](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5305)* +*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 @@ -16294,7 +8720,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5054](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5054)* +*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. @@ -16316,184 +8742,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5192)* - -**Parameters:** - -Name | Type | ------- | ------ | -`order` | object | -`takerAssetFillAmount` | `BigNumber` | -`signature` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### fillOrderNoThrow - -#### ▪ **fillOrderNoThrow**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1353](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1353)* - -Fills the input order. -Returns false if the transaction would otherwise revert. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1415](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1415)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | Order struct containing order specifications. | -`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | -`signature` | string | Proof that order has been created by maker. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1543](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1543)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | Order struct containing order specifications. | -`takerAssetFillAmount` | `BigNumber` | - | Desired amount of takerAsset to sell. | -`signature` | string | - | Proof that order has been created by maker. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Amounts filled and fees paid by maker and taker. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1465](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1465)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | Order struct containing order specifications. | -`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | -`signature` | string | Proof that order has been created by maker. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1693](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1693)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *object* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1651](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1651)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *object* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1619](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1619)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | Order struct containing order specifications. | -`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | -`signature` | string | Proof that order has been created by maker. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1363](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1363)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | Order struct containing order specifications. | -`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | -`signature` | string | Proof that order has been created by maker. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1506](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1506)* +*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:** @@ -16512,13 +8761,13 @@ ___ #### ▪ **filled**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L93)* +*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:99](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L99)* +*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 @@ -16538,7 +8787,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:164](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L164)* +*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 @@ -16556,7 +8805,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:152](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L152)* +*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 @@ -16574,7 +8823,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:141](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L141)* +*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 @@ -16596,7 +8845,7 @@ ___ #### ▪ **getAssetProxy**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3040](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3040)* +*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. @@ -16604,7 +8853,7 @@ Gets an asset proxy. ▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3048](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3048)* +*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 @@ -16626,7 +8875,7 @@ The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registere ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3114](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3114)* +*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 @@ -16644,7 +8893,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3102](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3102)* +*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 @@ -16662,7 +8911,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`assetProxyId`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3091](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3091)* +*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 @@ -16684,7 +8933,7 @@ ___ #### ▪ **getOrderInfo**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5834](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5834)* +*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. @@ -16692,7 +8941,7 @@ Gets information about an order: status, hash, and amount filled. ▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5842](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5842)* +*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 @@ -16714,7 +8963,7 @@ OrderInfo Information about the order and its state. See LibOrder.OrderI ▸ **getABIDecodedReturnData**(`returnData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5974](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5974)* +*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 @@ -16732,7 +8981,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5932](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5932)* +*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 @@ -16750,7 +8999,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`order`: object): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5906](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5906)* +*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 @@ -16768,99 +9017,11 @@ The ABI encoded transaction data as a string ___ -### getOrdersInfo +### isValidHashSignature -#### ▪ **getOrdersInfo**: *object* +#### ▪ **isValidHashSignature**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4246](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4246)* - -Fetches information for all passed in orders. - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4254](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4254)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise>`* - -Array of OrderInfo instances that correspond to each order. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4390](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4390)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *`Array`* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4346](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4346)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *`Array`* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4317](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4317)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### isValidSignature - -#### ▪ **isValidSignature**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4568](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4568)* +*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. @@ -16868,7 +9029,7 @@ Verifies that a hash has been signed by the given signer. ▸ **callAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4578](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4578)* +*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 @@ -16878,7 +9039,7 @@ since they don't modify state. Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`hash` | string | - | Any 32 byte hash. | +`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` | {} | - | @@ -16886,13 +9047,13 @@ Name | Type | Default | Description | **Returns:** *`Promise`* -True if the address recovered from the provided signature matches the input signer address. +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:4660](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4660)* +*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 @@ -16910,7 +9071,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4648](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4648)* +*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 @@ -16928,7 +9089,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4631](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4631)* +*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 @@ -16938,7 +9099,7 @@ to create a 0x transaction (see protocol spec for more details). Name | Type | Description | ------ | ------ | ------ | -`hash` | string | Any 32 byte hash. | +`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. | @@ -16948,19 +9109,200 @@ The ABI encoded transaction data as a string ___ -### marketBuyOrders +### isValidOrderSignature -#### ▪ **marketBuyOrders**: *object* +#### ▪ **isValidOrderSignature**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6905](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6905)* +*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)* -Synchronously executes multiple calls of fillOrder until total amount of makerAsset is bought by taker. +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:6968](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6968)* +*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. @@ -16970,7 +9312,7 @@ If the transaction was mined, but reverted, an error is thrown. Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | -`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`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 | @@ -16984,7 +9326,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7098](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7098)* +*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 @@ -16995,7 +9337,7 @@ since they don't modify state. Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications. | -`makerAssetFillAmount` | `BigNumber` | - | Desired amount of makerAsset to buy. | +`makerAssetFillAmount` | `BigNumber` | - | Minimum amount of makerAsset to buy. | `signatures` | string[] | - | Proofs that orders have been signed by makers. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | @@ -17008,7 +9350,7 @@ Amounts filled and fees paid by makers and taker. ▸ **estimateGasAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7019](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7019)* +*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. @@ -17017,7 +9359,7 @@ Estimates the gas cost of sending an Ethereum transaction calling this method wi Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | -`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`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 | @@ -17029,7 +9371,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7252](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7252)* +*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 @@ -17047,7 +9389,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7208](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7208)* +*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 @@ -17065,7 +9407,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7175)* +*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 @@ -17076,7 +9418,7 @@ to create a 0x transaction (see protocol spec for more details). Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | -`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`makerAssetFillAmount` | `BigNumber` | Minimum amount of makerAsset to buy. | `signatures` | string[] | Proofs that orders have been signed by makers. | **Returns:** *string* @@ -17087,7 +9429,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6915](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6915)* +*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. @@ -17097,7 +9439,7 @@ Ethereum operation and will cost gas. Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | -`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | +`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 | @@ -17109,7 +9451,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7061](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7061)* +*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:** @@ -17128,16 +9470,17 @@ ___ #### ▪ **marketBuyOrdersNoThrow**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4672](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4672)* +*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)* -Synchronously executes multiple fill orders in a single transaction until total amount is bought by taker. -Returns false if the transaction would otherwise revert. +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:4735](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4735)* +*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. @@ -17161,7 +9504,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4865](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4865)* +*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 @@ -17185,7 +9528,7 @@ Amounts filled and fees paid by makers and taker. ▸ **estimateGasAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4786](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4786)* +*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. @@ -17206,7 +9549,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5019](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5019)* +*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 @@ -17224,7 +9567,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4975](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4975)* +*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 @@ -17242,7 +9585,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4942](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4942)* +*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 @@ -17264,7 +9607,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4682](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4682)* +*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. @@ -17286,7 +9629,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4828](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4828)* +*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:** @@ -17301,19 +9644,20 @@ Name | Type | ___ -### marketSellOrders +### marketSellOrdersFillOrKill -#### ▪ **marketSellOrders**: *object* +#### ▪ **marketSellOrdersFillOrKill**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3874](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3874)* +*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)* -Synchronously executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. +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:3937](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3937)* +*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. @@ -17323,8 +9667,8 @@ If the transaction was mined, but reverted, an error is thrown. Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | -`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | -`signatures` | string[] | Proofs that orders have been created by makers. | +`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 | - | @@ -17337,7 +9681,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4067](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4067)* +*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 @@ -17348,8 +9692,8 @@ since they don't modify state. Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications. | -`takerAssetFillAmount` | `BigNumber` | - | Desired amount of takerAsset to sell. | -`signatures` | string[] | - | Proofs that orders have been created by makers. | +`takerAssetFillAmount` | `BigNumber` | - | Minimum amount of takerAsset to sell. | +`signatures` | string[] | - | Proofs that orders have been signed by makers. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | @@ -17361,7 +9705,7 @@ Amounts filled and fees paid by makers and taker. ▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3988](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3988)* +*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. @@ -17370,8 +9714,8 @@ Estimates the gas cost of sending an Ethereum transaction calling this method wi Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | -`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | -`signatures` | string[] | Proofs that orders have been created by makers. | +`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`* @@ -17382,7 +9726,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4221](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4221)* +*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 @@ -17400,7 +9744,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4177](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4177)* +*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 @@ -17418,7 +9762,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4144](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4144)* +*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 @@ -17429,8 +9773,8 @@ to create a 0x transaction (see protocol spec for more details). Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | -`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | -`signatures` | string[] | Proofs that orders have been created by makers. | +`takerAssetFillAmount` | `BigNumber` | Minimum amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | **Returns:** *string* @@ -17440,7 +9784,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3884](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3884)* +*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. @@ -17450,8 +9794,8 @@ Ethereum operation and will cost gas. Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | -`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | -`signatures` | string[] | Proofs that orders have been created by makers. | +`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`* @@ -17462,7 +9806,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4030](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4030)* +*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:** @@ -17481,16 +9825,17 @@ ___ #### ▪ **marketSellOrdersNoThrow**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6460](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6460)* +*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)* -Synchronously executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. -Returns false if the transaction would otherwise revert. +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:6523](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6523)* +*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. @@ -17514,7 +9859,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6653](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6653)* +*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 @@ -17538,7 +9883,7 @@ Amounts filled and fees paid by makers and taker. ▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6574](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6574)* +*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. @@ -17559,7 +9904,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6807](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6807)* +*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 @@ -17577,7 +9922,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6763](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6763)* +*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 @@ -17595,7 +9940,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6730](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6730)* +*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 @@ -17617,7 +9962,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6470](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6470)* +*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. @@ -17639,7 +9984,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6616](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6616)* +*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:** @@ -17658,7 +10003,7 @@ ___ #### ▪ **matchOrders**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L860)* +*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 @@ -17669,7 +10014,7 @@ The profit made by the left order goes to the taker (who matched the two orders) ▸ **awaitTransactionSuccessAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:938](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L938)* +*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. @@ -17694,7 +10039,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1112)* +*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 @@ -17719,7 +10064,7 @@ matchedFillResults Amounts filled and fees paid by maker and taker of matched or ▸ **estimateGasAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1004](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1004)* +*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. @@ -17741,7 +10086,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1309](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1309)* +*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 @@ -17759,7 +10104,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1267](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1267)* +*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 @@ -17777,7 +10122,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1221](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1221)* +*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 @@ -17800,7 +10145,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:871](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L871)* +*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. @@ -17823,7 +10168,192 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1059](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1059)* +*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:** @@ -17843,13 +10373,13 @@ ___ #### ▪ **orderEpoch**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6295](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6295)* +*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:6301](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6301)* +*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 @@ -17870,7 +10400,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6375](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6375)* +*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 @@ -17888,7 +10418,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6363](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6363)* +*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 @@ -17906,7 +10436,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6348](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6348)* +*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 @@ -17929,13 +10459,13 @@ ___ #### ▪ **owner**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4492](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4492)* +*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:4498](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4498)* +*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 @@ -17954,7 +10484,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4557)* +*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 @@ -17972,7 +10502,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4545](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4545)* +*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 @@ -17990,7 +10520,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4535](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4535)* +*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 @@ -18006,16 +10536,16 @@ ___ #### ▪ **preSign**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:632](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L632)* +*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 using any valid signature type. +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, `signerAddress`: string, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* +▸ **awaitTransactionSuccessAsync**(`hash`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:681](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L681)* +*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. @@ -18024,9 +10554,7 @@ If the transaction was mined, but reverted, an error is thrown. Name | Type | Description | ------ | ------ | ------ | -`hash` | string | - | -`signerAddress` | string | Address that should have signed the given hash. | -`signature` | string | Proof that the hash has been signed by signer. | +`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 | - | @@ -18037,9 +10565,9 @@ A promise that resolves when the transaction is successful #### callAsync -▸ **callAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **callAsync**(`hash`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:765](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L765)* +*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 @@ -18049,9 +10577,7 @@ since they don't modify state. Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`hash` | string | - | - | -`signerAddress` | string | - | Address that should have signed the given hash. | -`signature` | string | - | Proof that the hash has been signed by signer. | +`hash` | string | - | Any 32-byte hash. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | @@ -18059,9 +10585,9 @@ Name | Type | Default | Description | #### estimateGasAsync -▸ **estimateGasAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* +▸ **estimateGasAsync**(`hash`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:718](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L718)* +*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. @@ -18069,9 +10595,7 @@ Estimates the gas cost of sending an Ethereum transaction calling this method wi Name | Type | Description | ------ | ------ | ------ | -`hash` | string | - | -`signerAddress` | string | Address that should have signed the given hash. | -`signature` | string | Proof that the hash has been signed by signer. | +`hash` | string | Any 32-byte hash. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* @@ -18082,7 +10606,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:846](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L846)* +*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 @@ -18098,9 +10622,9 @@ An array representing the output results in order. Keynames of nested structs a #### getABIDecodedTransactionData -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, string]* +▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:834](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L834)* +*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 @@ -18110,15 +10634,15 @@ Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | -**Returns:** *[string, string, string]* +**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* +▸ **getABIEncodedTransactionData**(`hash`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:817](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L817)* +*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 @@ -18128,9 +10652,7 @@ to create a 0x transaction (see protocol spec for more details). Name | Type | Description | ------ | ------ | ------ | -`hash` | string | - | -`signerAddress` | string | Address that should have signed the given hash. | -`signature` | string | Proof that the hash has been signed by signer. | +`hash` | string | Any 32-byte hash. | **Returns:** *string* @@ -18138,9 +10660,9 @@ The ABI encoded transaction data as a string #### sendTransactionAsync -▸ **sendTransactionAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* +▸ **sendTransactionAsync**(`hash`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:641](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L641)* +*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. @@ -18149,9 +10671,7 @@ Ethereum operation and will cost gas. Name | Type | Description | ------ | ------ | ------ | -`hash` | string | - | -`signerAddress` | string | Address that should have signed the given hash. | -`signature` | string | Proof that the hash has been signed by signer. | +`hash` | string | Any 32-byte hash. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* @@ -18160,17 +10680,15 @@ The hash of the transaction #### validateAndSendTransactionAsync -▸ **validateAndSendTransactionAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* +▸ **validateAndSendTransactionAsync**(`hash`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L748)* +*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 | -`signerAddress` | string | -`signature` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* @@ -18181,13 +10699,13 @@ ___ #### ▪ **preSigned**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4404](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4404)* +*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:4410](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4410)* +*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 @@ -18208,7 +10726,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4484](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4484)* +*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 @@ -18226,7 +10744,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4472)* +*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 @@ -18244,7 +10762,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4457](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4457)* +*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 @@ -18263,11 +10781,165 @@ 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:5659](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5659)* +*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. @@ -18276,7 +10948,7 @@ Once an asset proxy is registered, it cannot be unregistered. ▸ **awaitTransactionSuccessAsync**(`assetProxy`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5695](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5695)* +*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. @@ -18298,7 +10970,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`assetProxy`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5755](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5755)* +*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 @@ -18318,7 +10990,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5722](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5722)* +*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. @@ -18337,7 +11009,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5823](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5823)* +*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 @@ -18355,7 +11027,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5811](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5811)* +*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 @@ -18373,7 +11045,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5798](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5798)* +*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 @@ -18393,7 +11065,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5667)* +*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. @@ -18413,7 +11085,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5741](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5741)* +*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:** @@ -18426,19 +11098,344 @@ Name | Type | ___ +### 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:3568](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3568)* +*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. +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:3618](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3618)* +*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. @@ -18461,7 +11458,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`validatorAddress`: string, `approval`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3699](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3699)* +*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 @@ -18482,7 +11479,7 @@ Name | Type | Default | Description | ▸ **estimateGasAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3652](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3652)* +*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. @@ -18502,7 +11499,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3775](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3775)* +*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 @@ -18520,7 +11517,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3763](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3763)* +*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 @@ -18538,7 +11535,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`validatorAddress`: string, `approval`: boolean): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3748)* +*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 @@ -18559,7 +11556,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3577](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3577)* +*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. @@ -18580,7 +11577,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3679](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3679)* +*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:** @@ -18594,17 +11591,199 @@ Name | Type | ___ -### transactions +### simulateDispatchTransferFromCalls -#### ▪ **transactions**: *object* +#### ▪ **simulateDispatchTransferFromCalls**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3122)* +*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:3128](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3128)* +*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 @@ -18624,7 +11803,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3193](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3193)* +*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 @@ -18642,7 +11821,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3181)* +*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 @@ -18660,7 +11839,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3170)* +*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 @@ -18682,13 +11861,13 @@ ___ #### ▪ **transferOwnership**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7347](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7347)* +*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:7381](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7381)* +*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. @@ -18710,7 +11889,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7436](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7436)* +*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 @@ -18730,7 +11909,7 @@ Name | Type | Default | ▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7407](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7407)* +*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. @@ -18749,7 +11928,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7499](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7499)* +*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 @@ -18767,7 +11946,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7487](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7487)* +*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 @@ -18785,7 +11964,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7474](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7474)* +*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 @@ -18805,7 +11984,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7354](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7354)* +*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. @@ -18825,7 +12004,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7426)* +*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:** @@ -18838,972 +12017,6 @@ Name | Type |
-# Class: ForwarderContract - - -## Constructors - - - -\+ **new ForwarderContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ForwarderContract](#class-forwardercontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:2273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L2273)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ForwarderContract](#class-forwardercontract)* - -## Properties - -#### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1834](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1834)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string, `_wethAssetData`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1785](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1785)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | -`_zrxAssetData` | string | -`_wethAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string, `_wethAssetData`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1748)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | -`_zrxAssetData` | string | -`_wethAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### marketBuyOrdersWithEth - -#### ▪ **marketBuyOrdersWithEth**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:36](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L36)* - -Attempt to purchase makerAssetFillAmount of makerAsset by selling ETH provided with transaction. -Any ZRX required to pay fees for primary orders will automatically be purchased by this contract. -Any ETH not spent will be refunded to sender. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:151](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L151)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, object]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:379](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L379)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`makerAssetFillAmount` | `BigNumber` | - | Desired amount of makerAsset to purchase. | -`signatures` | string[] | - | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | - | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | - | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | - | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | - | Address that will receive ETH when orders are filled. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[object, object]>`* - -Amounts filled and fees paid by maker and taker for both sets of orders. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:234](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L234)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *[object, object]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:660](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L660)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *[object, object]* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, `BigNumber`, string[], `Array`, string[], `BigNumber`, string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:574](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L574)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[`Array`, `BigNumber`, string[], `Array`, string[], `BigNumber`, string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:512](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L512)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L53)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:305](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L305)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Array` | -`makerAssetFillAmount` | `BigNumber` | -`signatures` | string[] | -`feeOrders` | `Array` | -`feeSignatures` | string[] | -`feePercentage` | `BigNumber` | -`feeRecipient` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### marketSellOrdersWithEth - -#### ▪ **marketSellOrdersWithEth**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:978](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L978)* - -Purchases as much of orders' makerAssets as possible by selling up to 95% of transaction's ETH value. -Any ZRX required to pay fees for primary orders will automatically be purchased by this contract. -5% of ETH value is reserved for paying fees to order feeRecipients (in ZRX) and forwarding contract feeRecipient (in ETH). -Any ETH not spent will be refunded to sender. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1080](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1080)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, object]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1290](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1290)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`signatures` | string[] | - | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | - | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | - | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | - | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | - | Address that will receive ETH when orders are filled. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[object, object]>`* - -Amounts filled and fees paid by maker and taker for both sets of orders. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1159](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1159)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *[object, object]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1548)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *[object, object]* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[], `Array`, string[], `BigNumber`, string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1464](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1464)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[`Array`, string[], `Array`, string[], `BigNumber`, string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1412](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1412)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:994](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L994)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1220](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1220)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Array` | -`signatures` | string[] | -`feeOrders` | `Array` | -`feeSignatures` | string[] | -`feePercentage` | `BigNumber` | -`feeRecipient` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L899)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:905](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L905)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:964](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L964)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:952](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L952)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:942](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L942)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1588](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1588)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1622](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1622)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1677](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1677)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`newOwner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1648](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1648)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1740](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1740)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1728](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1728)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1715](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1715)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1595](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1595)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1667)* - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### withdrawAsset - -#### ▪ **withdrawAsset**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:705](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L705)* - -Withdraws assets from this contract. The contract requires a ZRX balance in order to -function optimally, and this function allows the ZRX to be withdrawn by owner. It may also be -used to withdraw assets that were accidentally sent to this contract. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L748)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Byte array encoded for the respective asset proxy. | -`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`assetData`: string, `amount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L818)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | Byte array encoded for the respective asset proxy. | -`amount` | `BigNumber` | - | Amount of ERC20 token to withdraw. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:778](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L778)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Byte array encoded for the respective asset proxy. | -`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:891](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L891)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:879](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L879)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, `BigNumber`]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetData`: string, `amount`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:864](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L864)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Byte array encoded for the respective asset proxy. | -`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:714](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L714)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Byte array encoded for the respective asset proxy. | -`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:802](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L802)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`amount` | `BigNumber` | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -
- # Class: IValidatorContract @@ -19811,20 +12024,21 @@ Name | Type | -\+ **new IValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[IValidatorContract](#class-ivalidatorcontract)* +\+ **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:232](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L232)* +*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 | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | IValidatorContract.deployedBytecode | **Returns:** *[IValidatorContract](#class-ivalidatorcontract)* @@ -19836,7 +12050,7 @@ Name | Type | -Defined in base-contract/lib/src/index.d.ts:25 +Defined in base-contract/lib/src/index.d.ts:27 ___ @@ -19846,7 +12060,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:26 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -19856,7 +12070,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -19866,7 +12080,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +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 @@ -19876,7 +12098,7 @@ Defined in base-contract/lib/src/index.d.ts:27 -Defined in base-contract/lib/src/index.d.ts:38 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -19892,7 +12114,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:201](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L201)* +*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)* @@ -19904,7 +12126,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:159](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L159)* +*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:** @@ -19924,7 +12146,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:134](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L134)* +*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:** @@ -19945,7 +12167,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:37 +Defined in base-contract/lib/src/index.d.ts:41 **Parameters:** @@ -19962,7 +12184,7 @@ Name | Type | #### ▪ **isValidSignature**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L34)* +*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. @@ -19970,7 +12192,7 @@ Verifies that a signature is valid. ▸ **callAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L44)* +*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 @@ -19994,7 +12216,7 @@ Magic bytes4 value if the signature is valid. Magic value is bytes4(kecc ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:126](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L126)* +*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 @@ -20012,7 +12234,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:114](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L114)* +*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 @@ -20030,7 +12252,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:97](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L97)* +*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 @@ -20057,20 +12279,21 @@ The ABI encoded transaction data as a string -\+ **new IWalletContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[IWalletContract](#class-iwalletcontract)* +\+ **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:218](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L218)* +*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 | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | IWalletContract.deployedBytecode | **Returns:** *[IWalletContract](#class-iwalletcontract)* @@ -20082,7 +12305,7 @@ Name | Type | -Defined in base-contract/lib/src/index.d.ts:25 +Defined in base-contract/lib/src/index.d.ts:27 ___ @@ -20092,7 +12315,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:26 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -20102,7 +12325,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -20112,7 +12335,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +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 @@ -20122,7 +12353,7 @@ Defined in base-contract/lib/src/index.d.ts:27 -Defined in base-contract/lib/src/index.d.ts:38 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -20138,7 +12369,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:191](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L191)* +*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)* @@ -20150,7 +12381,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:149](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L149)* +*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:** @@ -20170,7 +12401,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L124)* +*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:** @@ -20191,7 +12422,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:37 +Defined in base-contract/lib/src/index.d.ts:41 **Parameters:** @@ -20208,15 +12439,15 @@ Name | Type | #### ▪ **isValidSignature**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L34)* +*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)* -Verifies that a signature is valid. +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:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L43)* +*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 @@ -20233,13 +12464,13 @@ Name | Type | Default | Description | **Returns:** *`Promise`* -Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256("isValidWalletSignature(bytes32,address,bytes)")) +magicValue `bytes4(0xb0671381)` if the signature check succeeds. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:116](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L116)* +*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 @@ -20257,7 +12488,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:104](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L104)* +*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 @@ -20275,7 +12506,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:89](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L89)* +*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 @@ -20294,766 +12525,6 @@ The ABI encoded transaction data as a string
-# Class: OrderValidatorContract - - -## Constructors - - - -\+ **new OrderValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[OrderValidatorContract](#class-ordervalidatorcontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1751)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[OrderValidatorContract](#class-ordervalidatorcontract)* - -## Properties - -#### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1190](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1190)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1142)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | -`_zrxAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1107)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | -`_zrxAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### getBalanceAndAllowance - -#### ▪ **getBalanceAndAllowance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:244](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L244)* - -#### callAsync - -▸ **callAsync**(`target`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:250](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L250)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`target` | string | - | -`assetData` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[BigNumber, BigNumber]>`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:324](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L324)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *[`BigNumber`, `BigNumber`]* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:312](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L312)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `assetData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:297](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L297)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`assetData` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getBalancesAndAllowances - -#### ▪ **getBalancesAndAllowances**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:832](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L832)* - -#### callAsync - -▸ **callAsync**(`target`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:838](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L838)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`target` | string | - | -`assetData` | string[] | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`[], `BigNumber`[]]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:912](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L912)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *[`BigNumber`[], `BigNumber`[]]* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string[]]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:900](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L900)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[string, string[]]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `assetData`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:885](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L885)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`assetData` | string[] | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getERC721TokenOwner - -#### ▪ **getERC721TokenOwner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:744](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L744)* - -#### callAsync - -▸ **callAsync**(`token`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:750](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L750)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`token` | string | - | -`tokenId` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:824](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L824)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:812](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L812)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`token`: string, `tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:797](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L797)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`token` | string | -`tokenId` | `BigNumber` | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getOrderAndTraderInfo - -#### ▪ **getOrderAndTraderInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:31](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L31)* - -#### callAsync - -▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, object]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L37)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`order` | object | - | -`takerAddress` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[object, object]>`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *[object, object]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:206](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L206)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *[object, object]* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:156](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L156)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[object, string]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:126](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L126)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`order` | object | -`takerAddress` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getOrdersAndTradersInfo - -#### ▪ **getOrdersAndTradersInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:332](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L332)* - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, Array]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:338](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L338)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`orders` | `Array` | - | -`takerAddresses` | string[] | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[Array, Array]>`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *[`Array`, `Array`]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:509](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L509)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *[`Array`, `Array`]* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[]]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:459](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L459)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[`Array`, string[]]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L428)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Array` | -`takerAddresses` | string[] | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getTraderInfo - -#### ▪ **getTraderInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:920](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L920)* - -#### callAsync - -▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:926](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L926)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`order` | object | - | -`takerAddress` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1077](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1077)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *object* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1035](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1035)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *object* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1005](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1005)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`order` | object | -`takerAddress` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getTradersInfo - -#### ▪ **getTradersInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:547](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L547)* - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:553](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L553)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`orders` | `Array` | - | -`takerAddresses` | string[] | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise>`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:712](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L712)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *`Array`* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:668](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L668)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *`Array`* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L637)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Array` | -`takerAddresses` | string[] | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -
- # Class: WETH9Contract @@ -21061,20 +12532,21 @@ The ABI encoded transaction data as a string -\+ **new WETH9Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[WETH9Contract](#class-weth9contract)* +\+ **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:1831](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1831)* +*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 | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | WETH9Contract.deployedBytecode | **Returns:** *[WETH9Contract](#class-weth9contract)* @@ -21086,7 +12558,7 @@ Name | Type | -Defined in base-contract/lib/src/index.d.ts:25 +Defined in base-contract/lib/src/index.d.ts:27 ___ @@ -21096,7 +12568,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:26 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -21106,7 +12578,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -21116,7 +12588,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +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 @@ -21126,7 +12606,7 @@ Defined in base-contract/lib/src/index.d.ts:27 -Defined in base-contract/lib/src/index.d.ts:38 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -21142,7 +12622,7 @@ ___ ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1815](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1815)* +*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 @@ -21168,7 +12648,7 @@ ___ ▸ **subscribe**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1773](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1773)* +*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. @@ -21196,7 +12676,7 @@ ___ ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1798](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1798)* +*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 @@ -21214,7 +12694,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1804](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1804)* +*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 @@ -21226,7 +12706,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1476](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1476)* +*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)* @@ -21238,7 +12718,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1434](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1434)* +*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:** @@ -21258,7 +12738,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1409](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1409)* +*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:** @@ -21279,7 +12759,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:37 +Defined in base-contract/lib/src/index.d.ts:41 **Parameters:** @@ -21296,13 +12776,13 @@ Name | Type | #### ▪ **allowance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1320](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1320)* +*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:1326](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1326)* +*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 @@ -21323,7 +12803,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1400](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1400)* +*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 @@ -21341,7 +12821,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1388)* +*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 @@ -21359,7 +12839,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1373](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1373)* +*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 @@ -21382,13 +12862,13 @@ ___ #### ▪ **approve**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:146](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L146)* +*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/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L181)* +*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. @@ -21411,7 +12891,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`guy`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:243](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L243)* +*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 @@ -21432,7 +12912,7 @@ Name | Type | Default | ▸ **estimateGasAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:209](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L209)* +*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. @@ -21452,7 +12932,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:314](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L314)* +*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 @@ -21470,7 +12950,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:302](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L302)* +*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 @@ -21488,7 +12968,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`guy`: string, `wad`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:287](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L287)* +*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 @@ -21509,7 +12989,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:153](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L153)* +*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. @@ -21530,7 +13010,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:229](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L229)* +*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:** @@ -21548,13 +13028,13 @@ ___ #### ▪ **balanceOf**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:838](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L838)* +*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:844](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L844)* +*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 @@ -21574,7 +13054,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:911](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L911)* +*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 @@ -21592,7 +13072,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L899)* +*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 @@ -21610,7 +13090,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:886](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L886)* +*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 @@ -21632,13 +13112,13 @@ ___ #### ▪ **decimals**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:765](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L765)* +*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:771](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L771)* +*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 @@ -21657,7 +13137,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *number* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:830](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L830)* +*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 @@ -21675,7 +13155,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L818)* +*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 @@ -21693,7 +13173,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:808](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L808)* +*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 @@ -21709,13 +13189,13 @@ ___ #### ▪ **deposit**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1168)* +*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:1201](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1201)* +*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. @@ -21736,7 +13216,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1253](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1253)* +*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 @@ -21755,7 +13235,7 @@ Name | Type | Default | ▸ **estimateGasAsync**(`txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1225)* +*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. @@ -21773,7 +13253,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1312](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1312)* +*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 @@ -21791,7 +13271,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1300](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1300)* +*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 @@ -21809,7 +13289,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1290](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1290)* +*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 @@ -21823,7 +13303,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1175)* +*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. @@ -21842,7 +13322,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1243](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1243)* +*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:** @@ -21858,13 +13338,13 @@ ___ #### ▪ **name**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L73)* +*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:79](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L79)* +*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 @@ -21883,7 +13363,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:138](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L138)* +*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 @@ -21901,7 +13381,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:126](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L126)* +*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 @@ -21919,7 +13399,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:116](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L116)* +*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 @@ -21935,13 +13415,13 @@ ___ #### ▪ **symbol**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:919](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L919)* +*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:925](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L925)* +*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 @@ -21960,7 +13440,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:984](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L984)* +*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 @@ -21978,7 +13458,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:972](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L972)* +*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 @@ -21996,7 +13476,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:962](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L962)* +*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 @@ -22012,13 +13492,13 @@ ___ #### ▪ **totalSupply**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:322](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L322)* +*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:328](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L328)* +*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 @@ -22037,7 +13517,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:387](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L387)* +*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 @@ -22055,7 +13535,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:375](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L375)* +*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 @@ -22073,7 +13553,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:365](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L365)* +*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 @@ -22089,13 +13569,13 @@ ___ #### ▪ **transfer**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:992](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L992)* +*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:1027](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1027)* +*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. @@ -22118,7 +13598,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1089](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1089)* +*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 @@ -22139,7 +13619,7 @@ Name | Type | Default | ▸ **estimateGasAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1055](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1055)* +*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. @@ -22159,7 +13639,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1160](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1160)* +*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 @@ -22177,7 +13657,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1148](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1148)* +*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 @@ -22195,7 +13675,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`dst`: string, `wad`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1133](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1133)* +*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 @@ -22216,7 +13696,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:999](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L999)* +*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. @@ -22237,7 +13717,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1075](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1075)* +*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:** @@ -22255,13 +13735,13 @@ ___ #### ▪ **transferFrom**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:395](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L395)* +*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:440](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L440)* +*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. @@ -22285,7 +13765,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:520](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L520)* +*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 @@ -22307,7 +13787,7 @@ Name | Type | Default | ▸ **estimateGasAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:475](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L475)* +*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. @@ -22328,7 +13808,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:599](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L599)* +*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 @@ -22346,7 +13826,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:587](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L587)* +*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 @@ -22364,7 +13844,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`src`: string, `dst`: string, `wad`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:570](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L570)* +*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 @@ -22386,7 +13866,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:402](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L402)* +*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. @@ -22408,7 +13888,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:505](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L505)* +*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:** @@ -22427,13 +13907,13 @@ ___ #### ▪ **withdraw**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:607](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L607)* +*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:641](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L641)* +*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. @@ -22455,7 +13935,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:696](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L696)* +*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 @@ -22475,7 +13955,7 @@ Name | Type | Default | ▸ **estimateGasAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L667)* +*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. @@ -22494,7 +13974,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:757](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L757)* +*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 @@ -22512,7 +13992,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:745](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L745)* +*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 @@ -22530,7 +14010,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`wad`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:734](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L734)* +*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 @@ -22550,7 +14030,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:614](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L614)* +*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. @@ -22570,7 +14050,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:686](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L686)* +*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:** @@ -22590,20 +14070,21 @@ Name | Type | -\+ **new ZRXTokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ZRXTokenContract](#class-zrxtokencontract)* +\+ **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:1474](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1474)* +*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 | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ZRXTokenContract.deployedBytecode | **Returns:** *[ZRXTokenContract](#class-zrxtokencontract)* @@ -22615,7 +14096,7 @@ Name | Type | -Defined in base-contract/lib/src/index.d.ts:25 +Defined in base-contract/lib/src/index.d.ts:27 ___ @@ -22625,7 +14106,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:26 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -22635,7 +14116,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -22645,7 +14126,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +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 @@ -22655,7 +14144,7 @@ Defined in base-contract/lib/src/index.d.ts:27 -Defined in base-contract/lib/src/index.d.ts:38 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -22671,7 +14160,7 @@ ___ ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1458](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1458)* +*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 @@ -22697,7 +14186,7 @@ ___ ▸ **subscribe**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1416](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1416)* +*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. @@ -22725,7 +14214,7 @@ ___ ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1441](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1441)* +*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 @@ -22743,7 +14232,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1447](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1447)* +*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 @@ -22755,7 +14244,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1188](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1188)* +*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)* @@ -22767,7 +14256,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1146](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1146)* +*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:** @@ -22787,7 +14276,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1121](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1121)* +*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:** @@ -22808,7 +14297,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:37 +Defined in base-contract/lib/src/index.d.ts:41 **Parameters:** @@ -22825,13 +14314,13 @@ Name | Type | #### ▪ **allowance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1032](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1032)* +*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:1038](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1038)* +*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 @@ -22852,7 +14341,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1112)* +*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 @@ -22870,7 +14359,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1100](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1100)* +*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 @@ -22888,7 +14377,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1085](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1085)* +*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 @@ -22911,13 +14400,13 @@ ___ #### ▪ **approve**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L130)* +*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/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L172)* +*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. @@ -22940,7 +14429,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:241](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L241)* +*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 @@ -22961,7 +14450,7 @@ Name | Type | Default | ▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:200](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L200)* +*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. @@ -22981,7 +14470,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:315](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L315)* +*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 @@ -22999,7 +14488,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:303](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L303)* +*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 @@ -23017,7 +14506,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:288](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L288)* +*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 @@ -23038,7 +14527,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:137](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L137)* +*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. @@ -23059,7 +14548,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:227](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L227)* +*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:** @@ -23077,13 +14566,13 @@ ___ #### ▪ **balanceOf**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:700](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L700)* +*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:706](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L706)* +*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 @@ -23103,7 +14592,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:771](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L771)* +*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 @@ -23121,7 +14610,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:759](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L759)* +*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 @@ -23139,7 +14628,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_owner`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L748)* +*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 @@ -23161,13 +14650,13 @@ ___ #### ▪ **decimals**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:627](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L627)* +*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:633](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L633)* +*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 @@ -23186,7 +14675,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *number* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:692](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L692)* +*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 @@ -23204,7 +14693,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:680](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L680)* +*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 @@ -23222,7 +14711,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:670](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L670)* +*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 @@ -23238,13 +14727,13 @@ ___ #### ▪ **name**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L57)* +*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:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L63)* +*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 @@ -23263,7 +14752,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L122)* +*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 @@ -23281,7 +14770,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:110](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L110)* +*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 @@ -23299,7 +14788,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:100](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L100)* +*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 @@ -23315,13 +14804,13 @@ ___ #### ▪ **symbol**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:779](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L779)* +*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:785](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L785)* +*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 @@ -23340,7 +14829,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:844](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L844)* +*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 @@ -23358,7 +14847,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:832](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L832)* +*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 @@ -23376,7 +14865,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:822](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L822)* +*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 @@ -23392,13 +14881,13 @@ ___ #### ▪ **totalSupply**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:323](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L323)* +*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:329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L329)* +*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 @@ -23417,7 +14906,7 @@ Name | Type | Default | ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L388)* +*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 @@ -23435,7 +14924,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:376](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L376)* +*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 @@ -23453,7 +14942,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:366](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L366)* +*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 @@ -23469,13 +14958,13 @@ ___ #### ▪ **transfer**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:852](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L852)* +*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:891](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L891)* +*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. @@ -23498,7 +14987,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:953](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L953)* +*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 @@ -23519,7 +15008,7 @@ Name | Type | Default | ▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:919](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L919)* +*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. @@ -23539,7 +15028,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1024](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1024)* +*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 @@ -23557,7 +15046,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1012](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1012)* +*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 @@ -23575,7 +15064,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:997](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L997)* +*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 @@ -23596,7 +15085,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:859](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L859)* +*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. @@ -23617,7 +15106,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:939](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L939)* +*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:** @@ -23635,7 +15124,7 @@ ___ #### ▪ **transferFrom**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:399](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L399)* +*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. @@ -23643,7 +15132,7 @@ ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an un ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:450](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L450)* +*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. @@ -23667,7 +15156,7 @@ A promise that resolves when the transaction is successful ▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:537](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L537)* +*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 @@ -23691,7 +15180,7 @@ Success of transfer. ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:488](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L488)* +*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. @@ -23712,7 +15201,7 @@ The hash of the transaction ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:619](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L619)* +*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 @@ -23730,7 +15219,7 @@ An array representing the output results in order. Keynames of nested structs a ▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:607](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L607)* +*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 @@ -23748,7 +15237,7 @@ An array representing the input arguments in order. Keynames of nested structs a ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:590](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L590)* +*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 @@ -23770,7 +15259,7 @@ The ABI encoded transaction data as a string ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:409](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L409)* +*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. @@ -23792,7 +15281,7 @@ The hash of the transaction ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:518](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L518)* +*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:** @@ -23807,650 +15296,6 @@ Name | Type |
-# Class: ContractWrappers - -The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. - - -## Constructors - - - -\+ **new ContractWrappers**(`supportedProvider`: [SupportedProvider](#supportedprovider), `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:84](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L84)* - -Instantiates a new ContractWrappers instance. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | The Provider instance you would like the contract-wrappers library to use for interacting with the Ethereum network. | -`config` | [ContractWrappersConfig](#interface-contractwrappersconfig) | The configuration object. Look up the type for the description. | - -**Returns:** *[ContractWrappers](#class-contractwrappers)* - -An instance of the ContractWrappers class. - -## Properties - -#### contractAddresses - -• **contractAddresses**: *`ContractAddresses`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L43)* - -An index of the default contract addresses for this network. - -___ - -### coordinator - -• **coordinator**: *[CoordinatorWrapper](#class-coordinatorwrapper)* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:82](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L82)* - -An instance of the CoordinatorWrapper class containing methods for interacting with the Coordinator extension contract. - -___ - -### devUtils - -• **devUtils**: *`DevUtilsContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L78)* - -An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract. - -___ - -### dutchAuction - -• **dutchAuction**: *`DutchAuctionContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L74)* - -An instance of the DutchAuctionContract class containing methods for interacting with any DutchAuction smart contract. - -___ - -### erc20Proxy - -• **erc20Proxy**: *`ERC20ProxyContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L52)* - -An instance of the ERC20ProxyContract class containing methods for interacting with the -erc20Proxy smart contract. - -___ - -### erc721Proxy - -• **erc721Proxy**: *`ERC721ProxyContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L57)* - -An instance of the ERC721ProxyContract class containing methods for interacting with the -erc721Proxy smart contract. - -___ - -### exchange - -• **exchange**: *`ExchangeContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L47)* - -An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. - -___ - -### forwarder - -• **forwarder**: *`ForwarderContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L66)* - -An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. - -___ - -### orderValidator - -• **orderValidator**: *`OrderValidatorContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L70)* - -An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract. - -___ - -### weth9 - -• **weth9**: *`WETH9Contract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:62](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L62)* - -An instance of the WETH9Contract class containing methods for interacting with the -WETH9 smart contract. - -## Methods - -### getAbiDecoder - -▸ **getAbiDecoder**(): *`AbiDecoder`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:155](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L155)* - -Get the abi decoder instance currently used by contract-wrappers - -**Returns:** *`AbiDecoder`* - -AbiDecoder instance - -___ - -### getProvider - -▸ **getProvider**(): *[SupportedProvider](#supportedprovider)* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:148](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L148)* - -Get the provider instance currently used by contract-wrappers - -**Returns:** *[SupportedProvider](#supportedprovider)* - -Web3 provider instance - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:138](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L138)* - -Unsubscribes from all subscriptions for all contracts. - -**Returns:** *void* - -
- -# Class: CoordinatorWrapper - -This class includes all the functionality related to filling or cancelling orders through -the 0x V2 Coordinator extension contract. - - -## Constructors - - - -\+ **new CoordinatorWrapper**(`provider`: [SupportedProvider](#supportedprovider), `networkId`: number, `address?`: undefined | string, `exchangeAddress?`: undefined | string, `registryAddress?`: undefined | string): *[CoordinatorWrapper](#class-coordinatorwrapper)* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L43)* - -Instantiate CoordinatorWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`provider` | [SupportedProvider](#supportedprovider) | - | -`networkId` | number | Desired networkId. | -`address?` | undefined \| string | The address of the Coordinator contract. If undefined, will default to the known address corresponding to the networkId. | -`exchangeAddress?` | undefined \| string | The address of the Exchange contract. If undefined, will default to the known address corresponding to the networkId. | -`registryAddress?` | undefined \| string | The address of the CoordinatorRegistry contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[CoordinatorWrapper](#class-coordinatorwrapper)* - -## Properties - -### abi - -• **abi**: *[ContractAbi](#contractabi)* = Coordinator.compilerOutput.abi - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L34)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L36)* - -___ - -### exchangeAddress - -• **exchangeAddress**: *string* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L37)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L35)* - -___ - -### registryAddress - -• **registryAddress**: *string* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L38)* - -## Methods - -### assertValidCoordinatorApprovalsOrThrowAsync - -▸ **assertValidCoordinatorApprovalsOrThrowAsync**(`transaction`: `ZeroExTransaction`, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L637)* - -Validates that the 0x transaction has been approved by all of the feeRecipients that correspond to each order in the transaction's Exchange calldata. -Throws an error if the transaction approvals are not valid. Will not detect failures that would occur when the transaction is executed on the Exchange contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | `ZeroExTransaction` | 0x transaction containing salt, signerAddress, and data. | -`txOrigin` | string | Required signer of Ethereum transaction calling this function. | -`transactionSignature` | string | Proof that the transaction has been signed by the signer. | -`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | -`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | - -**Returns:** *`Promise`* - -___ - -### batchFillOrKillOrdersAsync - -▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L273)* - -Batch version of fillOrKillOrderAsync. Executes multiple fills atomically in a single transaction. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### batchFillOrdersAsync - -▸ **batchFillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:203](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L203)* - -Batch version of fillOrderAsync. Executes multiple fills atomically in a single transaction. -Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints -registered in the coordinator registry contract. It requests a signature from each coordinator server before -submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the -signatures and then fills the order through the Exchange contract. -If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### batchFillOrdersNoThrowAsync - -▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:238](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L238)* - -No throw version of batchFillOrdersAsync - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### batchHardCancelOrdersAsync - -▸ **batchHardCancelOrdersAsync**(`orders`: `SignedOrder`[], `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L568)* - -Batch version of hardCancelOrderAsync. Cancels orders on-chain by submitting an Ethereum transaction. -Executes multiple cancels atomically in a single transaction. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `SignedOrder`[] | - | An array of orders to cancel. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### batchSoftCancelOrdersAsync - -▸ **batchSoftCancelOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L482)* - -Batch version of softCancelOrderAsync. Requests multiple soft cancels - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | An array of orders to cancel. | - -**Returns:** *`Promise`* - -CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response). - -___ - -### fillOrKillOrderAsync - -▸ **fillOrKillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:166](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L166)* - -Attempts to fill a specific amount of an order. If the entire amount specified cannot be filled, -the fill order is abandoned. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### fillOrderAsync - -▸ **fillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:101](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L101)* - -Fills a signed order with an amount denominated in baseUnits of the taker asset. Under-the-hood, this -method uses the `feeRecipientAddress` of the order to look up the coordinator server endpoint registered in the -coordinator registry contract. It requests a signature from that coordinator server before -submitting the order and signature as a 0x transaction to the coordinator extension contract. The coordinator extension -contract validates signatures and then fills the order via the Exchange contract. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### fillOrderNoThrowAsync - -▸ **fillOrderNoThrowAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:133](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L133)* - -No-throw version of fillOrderAsync. This version will not throw if the fill fails. This allows the caller to save gas at the expense of not knowing the reason the fill failed. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### getSignerAddressAsync - -▸ **getSignerAddressAsync**(`hash`: string, `signature`: string): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:669](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L669)* - -Recovers the address of a signer given a hash and signature. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`hash` | string | Any 32 byte hash. | -`signature` | string | Proof that the hash has been signed by signer. | - -**Returns:** *`Promise`* - -Signer address. - -___ - -### hardCancelOrderAsync - -▸ **hardCancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:536](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L536)* - -Cancels an order on-chain by submitting an Ethereum transaction. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | `Order` \| `SignedOrder` | - | An object that conforms to the Order or SignedOrder interface. The order you would like to cancel. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### hardCancelOrdersUpToAsync - -▸ **hardCancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:603](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L603)* - -Cancels orders on-chain by submitting an Ethereum transaction. -Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch -and senderAddress equal to coordinator extension contract address. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`targetOrderEpoch` | `BigNumber` | - | Target order epoch. | -`senderAddress` | string | - | Address that should send the transaction. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### marketBuyOrdersAsync - -▸ **marketBuyOrdersAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L313)* - -Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. -Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints -registered in the coordinator registry contract. It requests a signature from each coordinator server before -submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the -signatures and then fills the order through the Exchange contract. -If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`makerAssetFillAmount` | `BigNumber` | - | Maker asset fill amount. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### marketBuyOrdersNoThrowAsync - -▸ **marketBuyOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:384](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L384)* - -No throw version of marketBuyOrdersAsync - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`makerAssetFillAmount` | `BigNumber` | - | Maker asset fill amount. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### marketSellOrdersAsync - -▸ **marketSellOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:351](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L351)* - -Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. -Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints -registered in the coordinator registry contract. It requests a signature from each coordinator server before -submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the -signatures and then fills the order through the Exchange contract. -If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmount` | `BigNumber` | - | Taker asset fill amount. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### marketSellOrdersNoThrowAsync - -▸ **marketSellOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L417)* - -No throw version of marketSellOrdersAsync - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmount` | `BigNumber` | - | Taker asset fill amount. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### softCancelOrderAsync - -▸ **softCancelOrderAsync**(`order`: `Order` | `SignedOrder`): *`Promise`* - -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:447](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L447)* - -Soft cancel a given order. -Soft cancels are recorded only on coordinator operator servers and do not involve an Ethereum transaction. -See [soft cancels](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#soft-cancels). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | `Order` \| `SignedOrder` | An object that conforms to the Order or SignedOrder interface. The order you would like to cancel. | - -**Returns:** *`Promise`* - -CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response). - -
- # Class: MetamaskSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) @@ -24467,7 +15312,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/23602ec6b/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 @@ -24481,13 +15326,13 @@ Name | Type | Description | ## Methods -### emitPayloadAsync +#### emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*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 @@ -24511,7 +15356,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/metamask_subprovider.ts#L39)* +*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 @@ -24533,7 +15378,7 @@ ___ ▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/metamask_subprovider.ts#L117)* +*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 @@ -24558,7 +15403,7 @@ ___ -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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 @@ -24586,7 +15431,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/23602ec6b/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:** @@ -24605,7 +15450,7 @@ Name | Type | Default | Description | -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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 @@ -24629,7 +15474,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* +*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 @@ -24653,7 +15498,7 @@ ___ -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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 @@ -24669,206 +15514,6 @@ Name | Type | Description |
-# Class: AbiDecoder - -AbiDecoder allows you to decode event logs given a set of supplied contract ABI's. It takes the contract's event -signature from the ABI and attempts to decode the logs using it. - - -## Constructors - - - -\+ **new AbiDecoder**(`abiArrays`: [AbiDefinition](#abidefinition)[][]): *[AbiDecoder](#class-abidecoder)* - -*Defined in [utils/src/abi_decoder.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/utils/src/abi_decoder.ts#L42)* - -Instantiate an AbiDecoder - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`abiArrays` | [AbiDefinition](#abidefinition)[][] | An array of contract ABI's | - -**Returns:** *[AbiDecoder](#class-abidecoder)* - -AbiDecoder instance - -## Methods - -### addABI - -▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void* - -*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/utils/src/abi_decoder.ts#L158)* - -Adds a set of ABI definitions, after which calldata and logs targeting these ABI's can be decoded. -Additional properties can be included to disambiguate similar ABI's. For example, if two functions -have the same signature but different parameter names, then their ABI definitions can be disambiguated -by specifying a contract name. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`abiArray` | [AbiDefinition](#abidefinition)[] | - | -`contractName?` | undefined \| string | Name of contract that encapsulates the ABI definitions (optional). This can be used when decoding calldata to disambiguate methods with the same signature but different parameter names. | - -**Returns:** *void* - -___ - -### decodeCalldataOrThrow - -▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* - -*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/utils/src/abi_decoder.ts#L118)* - -Decodes calldata for a known ABI. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`calldata` | string | hex-encoded calldata. | -`contractName?` | undefined \| string | used to disambiguate similar ABI's (optional). | - -**Returns:** *`DecodedCalldata`* - -Decoded calldata. Includes: function name and signature, along with the decoded arguments. - -___ - -### tryToDecodeLogOrNoop - -▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* - -*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/utils/src/abi_decoder.ts#L58)* - -Attempt to decode a log given the ABI's the AbiDecoder knows about. - -**Type parameters:** - -▪ **ArgsType**: *`DecodedLogArgs`* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`log` | `LogEntry` | The log to attempt to decode | - -**Returns:** *`LogWithDecodedArgs` | [RawLog](#rawlog)* - -The decoded log if the requisite ABI was available. Otherwise the log unaltered. - -
- -# Enumeration: CoordinatorRegistryEvents - - -## Enumeration members - -### CoordinatorEndpointSet - -• **CoordinatorEndpointSet**: = "CoordinatorEndpointSet" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L37)* - -
- -# Enumeration: DummyERC20TokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L38)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)* - -
- -# Enumeration: DummyERC721TokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L41)* - -___ - -### ApprovalForAll - -• **ApprovalForAll**: = "ApprovalForAll" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L42)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L40)* - -
- -# Enumeration: ERC1155ProxyEvents - - -## Enumeration members - -### AuthorizedAddressAdded - -• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L39)* - -___ - -### AuthorizedAddressRemoved - -• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L40)* - -
- -# Enumeration: ERC20ProxyEvents - - -## Enumeration members - -### AuthorizedAddressAdded - -• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L39)* - -___ - -### AuthorizedAddressRemoved - -• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L40)* - -
- # Enumeration: ERC20TokenEvents @@ -24878,7 +15523,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L38)* +*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)* ___ @@ -24886,28 +15531,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)* - -
- -# Enumeration: ERC721ProxyEvents - - -## Enumeration members - -### AuthorizedAddressAdded - -• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L39)* - -___ - -### AuthorizedAddressRemoved - -• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L40)* +*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)*
@@ -24920,7 +15544,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L41)* +*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)* ___ @@ -24928,7 +15552,7 @@ ___ • **ApprovalForAll**: = "ApprovalForAll" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L42)* +*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)* ___ @@ -24936,7 +15560,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L40)* +*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)*
@@ -24949,7 +15573,7 @@ ___ • **AssetProxyRegistered**: = "AssetProxyRegistered" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L46)* +*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)* ___ @@ -24957,7 +15581,7 @@ ___ • **Cancel**: = "Cancel" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L44)* +*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)* ___ @@ -24965,7 +15589,7 @@ ___ • **CancelUpTo**: = "CancelUpTo" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:45](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L45)* +*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)* ___ @@ -24973,7 +15597,23 @@ ___ • **Fill**: = "Fill" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L43)* +*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)* ___ @@ -24981,7 +15621,15 @@ ___ • **SignatureValidatorApproval**: = "SignatureValidatorApproval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L42)* +*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)*
@@ -24994,7 +15642,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L41)* +*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)* ___ @@ -25002,7 +15650,7 @@ ___ • **Deposit**: = "Deposit" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L43)* +*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)* ___ @@ -25010,7 +15658,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L42)* +*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)* ___ @@ -25018,7 +15666,7 @@ ___ • **Withdrawal**: = "Withdrawal" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* +*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)*
@@ -25031,7 +15679,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L38)* +*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)* ___ @@ -25039,74 +15687,52 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L37)* +*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: OrderStatus +# Enumeration: NetworkId ## Enumeration members -### Cancelled +### Ganache -• **Cancelled**: +• **Ganache**: = 50 -*Defined in [contract-wrappers/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L91)* +*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L26)* ___ -### Expired +### Kovan -• **Expired**: +• **Kovan**: = 42 -*Defined in [contract-wrappers/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L89)* +*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L25)* ___ -### Fillable +### Mainnet -• **Fillable**: +• **Mainnet**: = 1 -*Defined in [contract-wrappers/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L88)* +*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L22)* ___ -### FullyFilled +### Rinkeby -• **FullyFilled**: +• **Rinkeby**: = 4 -*Defined in [contract-wrappers/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L90)* +*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L24)* ___ -### Invalid +### Ropsten -• **Invalid**: = 0 +• **Ropsten**: = 3 -*Defined in [contract-wrappers/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L85)* - -___ - -### InvalidMakerAssetAmount - -• **InvalidMakerAssetAmount**: - -*Defined in [contract-wrappers/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L86)* - -___ - -### InvalidTakerAssetAmount - -• **InvalidTakerAssetAmount**: - -*Defined in [contract-wrappers/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L87)* +*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L23)*
@@ -25121,7 +15747,7 @@ ___ • **Earliest**: = "earliest" -*Defined in [ethereum-types/src/index.ts:470](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L470)* +*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L478)* ___ @@ -25129,7 +15755,7 @@ ___ • **Latest**: = "latest" -*Defined in [ethereum-types/src/index.ts:471](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L471)* +*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L479)* ___ @@ -25137,7 +15763,7 @@ ___ • **Pending**: = "pending" -*Defined in [ethereum-types/src/index.ts:472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L472)* +*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L480)*
@@ -25160,7 +15786,7 @@ ___ • **ERC1155**: = "0xa7cb5fb7" -*Defined in [types/src/index.ts:171](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L171)* +*Defined in [types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L166)* ___ @@ -25168,7 +15794,15 @@ ___ • **ERC20**: = "0xf47261b0" -*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L168)* +*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)* ___ @@ -25176,7 +15810,7 @@ ___ • **ERC721**: = "0x02571792" -*Defined in [types/src/index.ts:169](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L169)* +*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L164)* ___ @@ -25184,7 +15818,7 @@ ___ • **MultiAsset**: = "0x94cfcdd7" -*Defined in [types/src/index.ts:170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L170)* +*Defined in [types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L165)* ___ @@ -25192,7 +15826,7 @@ ___ • **StaticCall**: = "0xc339d10a" -*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L172)* +*Defined in [types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L167)*
@@ -25204,16 +15838,28 @@ ___ + + + + # 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:159](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L159)* +*Defined in [types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L153)* ___ @@ -25221,7 +15867,7 @@ ___ • **EthSign**: -*Defined in [types/src/index.ts:160](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L160)* +*Defined in [types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L154)* ___ @@ -25229,7 +15875,7 @@ ___ • **Illegal**: -*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L157)* +*Defined in [types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L151)* ___ @@ -25237,7 +15883,7 @@ ___ • **Invalid**: -*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L158)* +*Defined in [types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L152)* ___ @@ -25245,7 +15891,7 @@ ___ • **NSignatureTypes**: -*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L164)* +*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L159)* ___ @@ -25253,7 +15899,7 @@ ___ • **PreSigned**: -*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L163)* +*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L157)* ___ @@ -25261,7 +15907,7 @@ ___ • **Validator**: -*Defined in [types/src/index.ts:162](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L162)* +*Defined in [types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L156)* ___ @@ -25269,7 +15915,7 @@ ___ • **Wallet**: -*Defined in [types/src/index.ts:161](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L161)* +*Defined in [types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L155)*
@@ -25281,335 +15927,6 @@ ___ - - -
- -# Interface: CoordinatorRegistryCoordinatorEndpointSetEventArgs - - -## Index - -### Properties - -* [coordinatorEndpoint](#coordinatorendpoint) -* [coordinatorOperator](#coordinatoroperator) - -## Properties - -### coordinatorEndpoint - -• **coordinatorEndpoint**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L42)* - -___ - -### coordinatorOperator - -• **coordinatorOperator**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L41)* - -
- -# Interface: DummyERC20TokenApprovalEventArgs - - -## Index - -### Properties - -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L48)* - -___ - -### _spender - -• **_spender**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L49)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L50)* - -
- -# Interface: DummyERC20TokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L42)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L43)* - -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L44)* - -
- -# Interface: DummyERC721TokenApprovalEventArgs - - -## Index - -### Properties - -* [_approved](#_approved) -* [_owner](#_owner) -* [_tokenId](#_tokenid) - -## Properties - -### _approved - -• **_approved**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L53)* - -___ - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L52)* - -___ - -### _tokenId - -• **_tokenId**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L54)* - -
- -# Interface: DummyERC721TokenApprovalForAllEventArgs - - -## Index - -### Properties - -* [_approved](#_approved) -* [_operator](#_operator) -* [_owner](#_owner) - -## Properties - -### _approved - -• **_approved**: *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L60)* - -___ - -### _operator - -• **_operator**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L59)* - -___ - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L58)* - -
- -# Interface: DummyERC721TokenTransferEventArgs - - -## Index - -### Properties - -* [_from](#_from) -* [_to](#_to) -* [_tokenId](#_tokenid) - -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L46)* - -___ - -### _to - -• **_to**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L47)* - -___ - -### _tokenId - -• **_tokenId**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L48)* - -
- -# Interface: ERC1155ProxyAuthorizedAddressAddedEventArgs - - -## Index - -### Properties - -* [caller](#caller) -* [target](#target) - -## Properties - -### caller - -• **caller**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:45](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L45)* - -___ - -### target - -• **target**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L44)* - -
- -# Interface: ERC1155ProxyAuthorizedAddressRemovedEventArgs - - -## Index - -### Properties - -* [caller](#caller) -* [target](#target) - -## Properties - -### caller - -• **caller**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L50)* - -___ - -### target - -• **target**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L49)* - -
- -# Interface: ERC20ProxyAuthorizedAddressAddedEventArgs - - -## Index - -### Properties - -* [caller](#caller) -* [target](#target) - -## Properties - -### caller - -• **caller**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:45](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L45)* - -___ - -### target - -• **target**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L44)* - -
- -# Interface: ERC20ProxyAuthorizedAddressRemovedEventArgs - - -## Index - -### Properties - -* [caller](#caller) -* [target](#target) - -## Properties - -### caller - -• **caller**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L50)* - -___ - -### target - -• **target**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L49)* - -
- # Interface: ERC20TokenApprovalEventArgs @@ -25627,7 +15944,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L48)* +*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)* ___ @@ -25635,7 +15952,7 @@ ___ • **_spender**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L49)* +*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)* ___ @@ -25643,7 +15960,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L50)* +*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)*
@@ -25664,7 +15981,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L42)* +*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)* ___ @@ -25672,7 +15989,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L43)* +*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)* ___ @@ -25680,63 +15997,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L44)* - -
- -# Interface: ERC721ProxyAuthorizedAddressAddedEventArgs - - -## Index - -### Properties - -* [caller](#caller) -* [target](#target) - -## Properties - -### caller - -• **caller**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:45](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L45)* - -___ - -### target - -• **target**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L44)* - -
- -# Interface: ERC721ProxyAuthorizedAddressRemovedEventArgs - - -## Index - -### Properties - -* [caller](#caller) -* [target](#target) - -## Properties - -### caller - -• **caller**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L50)* - -___ - -### target - -• **target**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L49)* +*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)*
@@ -25757,7 +16018,7 @@ ___ • **_approved**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L53)* +*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)* ___ @@ -25765,7 +16026,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L52)* +*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)* ___ @@ -25773,7 +16034,7 @@ ___ • **_tokenId**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L54)* +*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)*
@@ -25794,7 +16055,7 @@ ___ • **_approved**: *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L60)* +*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)* ___ @@ -25802,7 +16063,7 @@ ___ • **_operator**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L59)* +*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)* ___ @@ -25810,7 +16071,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L58)* +*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)*
@@ -25831,7 +16092,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L46)* +*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)* ___ @@ -25839,7 +16100,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L47)* +*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)* ___ @@ -25847,7 +16108,7 @@ ___ • **_tokenId**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L48)* +*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)*
@@ -25867,7 +16128,7 @@ ___ • **assetProxy**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)* +*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)* ___ @@ -25875,7 +16136,7 @@ ___ • **id**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)* +*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)*
@@ -25899,7 +16160,7 @@ ___ • **feeRecipientAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:71](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L71)* +*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)* ___ @@ -25907,7 +16168,7 @@ ___ • **makerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L70)* +*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)* ___ @@ -25915,7 +16176,7 @@ ___ • **makerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L74)* +*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)* ___ @@ -25923,7 +16184,7 @@ ___ • **orderHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L73)* +*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)* ___ @@ -25931,7 +16192,7 @@ ___ • **senderAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L72)* +*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)* ___ @@ -25939,7 +16200,7 @@ ___ • **takerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L75)* +*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)*
@@ -25952,7 +16213,7 @@ ___ * [makerAddress](#makeraddress) * [orderEpoch](#orderepoch) -* [senderAddress](#senderaddress) +* [orderSenderAddress](#ordersenderaddress) ## Properties @@ -25960,7 +16221,7 @@ ___ • **makerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* +*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)* ___ @@ -25968,15 +16229,15 @@ ___ • **orderEpoch**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* +*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)* ___ -### senderAddress +### orderSenderAddress -• **senderAddress**: *string* +• **orderSenderAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* +*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)*
@@ -25991,12 +16252,15 @@ ___ * [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 @@ -26005,7 +16269,7 @@ ___ • **feeRecipientAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L57)* +*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)* ___ @@ -26013,7 +16277,7 @@ ___ • **makerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L56)* +*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)* ___ @@ -26021,7 +16285,7 @@ ___ • **makerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* +*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)* ___ @@ -26029,7 +16293,15 @@ ___ • **makerAssetFilledAmount**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L60)* +*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)* ___ @@ -26037,7 +16309,7 @@ ___ • **makerFeePaid**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:62](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L62)* +*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)* ___ @@ -26045,7 +16317,15 @@ ___ • **orderHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* +*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)* ___ @@ -26053,7 +16333,7 @@ ___ • **senderAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:59](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L59)* +*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)* ___ @@ -26061,7 +16341,7 @@ ___ • **takerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:58](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L58)* +*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)* ___ @@ -26069,7 +16349,7 @@ ___ • **takerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* +*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)* ___ @@ -26077,7 +16357,15 @@ ___ • **takerAssetFilledAmount**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:61](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L61)* +*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)* ___ @@ -26085,7 +16373,63 @@ ___ • **takerFeePaid**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L63)* +*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)*
@@ -26096,17 +16440,17 @@ ___ ### Properties -* [approved](#approved) +* [isApproved](#isapproved) * [signerAddress](#signeraddress) * [validatorAddress](#validatoraddress) ## Properties -### approved +### isApproved -• **approved**: *boolean* +• **isApproved**: *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)* +*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)* ___ @@ -26114,7 +16458,7 @@ ___ • **signerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* +*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)* ___ @@ -26122,7 +16466,26 @@ ___ • **validatorAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* +*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)*
@@ -26143,7 +16506,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L48)* +*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)* ___ @@ -26151,7 +16514,7 @@ ___ • **_spender**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L49)* +*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)* ___ @@ -26159,7 +16522,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L50)* +*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)*
@@ -26179,7 +16542,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L60)* +*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)* ___ @@ -26187,7 +16550,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:61](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L61)* +*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)*
@@ -26208,7 +16571,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L54)* +*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)* ___ @@ -26216,7 +16579,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L55)* +*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)* ___ @@ -26224,7 +16587,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L56)* +*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)*
@@ -26244,7 +16607,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:65](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L65)* +*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)* ___ @@ -26252,7 +16615,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L66)* +*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)*
@@ -26273,7 +16636,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L48)* +*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)* ___ @@ -26281,7 +16644,7 @@ ___ • **_spender**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L49)* +*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)* ___ @@ -26289,7 +16652,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L50)* +*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)*
@@ -26310,7 +16673,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L42)* +*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)* ___ @@ -26318,7 +16681,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L43)* +*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)* ___ @@ -26326,7 +16689,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L44)* +*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)*
@@ -26339,7 +16702,7 @@ ___ • **assetProxyOwner**: *string* -*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L9)* +*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L9)* ___ @@ -26347,7 +16710,7 @@ ___ • **coordinator**: *string* -*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L14)* +*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L14)* ___ @@ -26355,7 +16718,7 @@ ___ • **coordinatorRegistry**: *string* -*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L13)* +*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L13)* ___ @@ -26363,7 +16726,7 @@ ___ • **devUtils**: *string* -*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L18)* +*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L18)* ___ @@ -26371,7 +16734,7 @@ ___ • **dutchAuction**: *string* -*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L12)* +*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L12)* ___ @@ -26379,7 +16742,7 @@ ___ • **erc1155Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L17)* +*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L17)* ___ @@ -26387,7 +16750,7 @@ ___ • **erc20Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L4)* +*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L4)* ___ @@ -26395,7 +16758,7 @@ ___ • **erc721Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L5)* +*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L5)* ___ @@ -26403,7 +16766,7 @@ ___ • **etherToken**: *string* -*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L7)* +*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L7)* ___ @@ -26411,7 +16774,7 @@ ___ • **exchange**: *string* -*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L8)* +*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L8)* ___ @@ -26419,7 +16782,7 @@ ___ • **forwarder**: *string* -*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L10)* +*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L10)* ___ @@ -26427,7 +16790,7 @@ ___ • **multiAssetProxy**: *string* -*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L15)* +*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L15)* ___ @@ -26435,7 +16798,7 @@ ___ • **orderValidator**: *string* -*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L11)* +*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L11)* ___ @@ -26443,7 +16806,7 @@ ___ • **staticCallProxy**: *string* -*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L16)* +*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-addresses/src/index.ts#L16)* ___ @@ -26451,186 +16814,10 @@ ___ • **zrxToken**: *string* -*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L6)* +*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:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L56)* - -___ - -### `Optional` contractAddresses - -• **contractAddresses**? : *[ContractAddresses](#class-contractaddresses)* - -*Defined in [contract-wrappers/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L55)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Defined in [contract-wrappers/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L54)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [contract-wrappers/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L53)* - -
- - - -# Interface: DecodedLogEvent <**ArgsType**> - -## Type parameters - -▪ **ArgsType**: *`DecodedLogArgs`* - - -## Properties - -### isRemoved - -• **isRemoved**: *boolean* - -*Defined in [contract-wrappers/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L7)* - -___ - -### log - -• **log**: *`LogWithDecodedArgs`* - -*Defined in [contract-wrappers/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L8)* - -
- -# Interface: IndexedFilterValues - - -## Hierarchy - -* **OrderAndTraderInfo** - - -## Properties - -### orderInfo - -• **orderInfo**: *[OrderInfo](#class-orderinfo)* - -*Defined in [contract-wrappers/src/types.ts:106](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L106)* - -___ - -### traderInfo - -• **traderInfo**: *[TraderInfo](#class-traderinfo)* - -*Defined in [contract-wrappers/src/types.ts:107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L107)* - -
- -# Interface: OrderInfo - - -## Properties - -### orderHash - -• **orderHash**: *string* - -*Defined in [contract-wrappers/src/types.ts:80](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L80)* - -___ - -### orderStatus - -• **orderStatus**: *[OrderStatus](#enumeration-orderstatus)* - -*Defined in [contract-wrappers/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L79)* - -___ - -### orderTakerAssetFilledAmount - -• **orderTakerAssetFilledAmount**: *`BigNumber`* - -*Defined in [contract-wrappers/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L81)* - -
- -# Interface: OrderTransactionOpts - -shouldValidate: Flag indicating whether the library should make attempts to validate a transaction before -broadcasting it. For example, order has a valid signature, maker has sufficient funds, etc. Default=true. - - -## Properties - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Inherited from [TransactionOpts](#interface-transactionopts).[gasLimit](#optional-gaslimit)* - -*Defined in [contract-wrappers/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L66)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Inherited from [TransactionOpts](#interface-transactionopts).[gasPrice](#optional-gasprice)* - -*Defined in [contract-wrappers/src/types.ts:65](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L65)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | number* - -*Inherited from [TransactionOpts](#interface-transactionopts).[nonce](#optional-nonce)* - -*Defined in [contract-wrappers/src/types.ts:67](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L67)* - -___ - -### `Optional` shouldValidate - -• **shouldValidate**? : *undefined | false | true* - -*Defined in [contract-wrappers/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L75)* - -
- - - - - - - # Interface: BlockRange @@ -26642,7 +16829,7 @@ ___ • **fromBlock**: *[BlockParam](#blockparam)* -*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L732)* +*Defined in [ethereum-types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L740)* ___ @@ -26650,7 +16837,7 @@ ___ • **toBlock**: *[BlockParam](#blockparam)* -*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L733)* +*Defined in [ethereum-types/src/index.ts:741](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L741)*
@@ -26669,7 +16856,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L387)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -26677,7 +16864,7 @@ ___ • **from**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:396](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L396)* +*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L402)* ___ @@ -26687,7 +16874,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L385)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -26697,7 +16884,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L386)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -26707,7 +16894,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L388)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -26717,7 +16904,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L383)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -26727,7 +16914,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L384)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
@@ -26744,7 +16931,7 @@ ___ • **name**: *"solc"* -*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L647)* +*Defined in [ethereum-types/src/index.ts:655](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L655)* ___ @@ -26752,7 +16939,7 @@ ___ • **settings**: *[CompilerSettings](#class-compilersettings)* -*Defined in [ethereum-types/src/index.ts:649](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L649)* +*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L657)* ___ @@ -26760,7 +16947,7 @@ ___ • **version**: *string* -*Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L648)* +*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L656)*
@@ -26773,7 +16960,7 @@ ___ • **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [ethereum-types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L681)* +*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L689)* ___ @@ -26781,7 +16968,7 @@ ___ • **libraries**? : *undefined | object* -*Defined in [ethereum-types/src/index.ts:683](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L683)* +*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L691)* ___ @@ -26789,7 +16976,7 @@ ___ • **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* -*Defined in [ethereum-types/src/index.ts:682](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L682)* +*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L690)* ___ @@ -26797,7 +16984,7 @@ ___ • **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* -*Defined in [ethereum-types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L680)* +*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L688)* ___ @@ -26805,7 +16992,7 @@ ___ • **outputSelection**: *object* -*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L688)* +*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: @@ -26819,7 +17006,7 @@ ___ • **remappings**? : *string[]* -*Defined in [ethereum-types/src/index.ts:679](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L679)* +*Defined in [ethereum-types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L687)*
@@ -26832,7 +17019,7 @@ ___ • **useLiteralContent**: *true* -*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L696)* +*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L704)*
@@ -26845,7 +17032,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L103)* +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L103)* ___ @@ -26853,7 +17040,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L104)* +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L104)* ___ @@ -26861,7 +17048,7 @@ ___ • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L105)* +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L105)* ___ @@ -26869,7 +17056,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L102)* +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L102)*
@@ -26896,7 +17083,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 [ethereum-types/src/index.ts:633](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L633)* +*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L641)* ___ @@ -26906,7 +17093,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* -*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L643)* +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L651)* ___ @@ -26914,7 +17101,7 @@ ___ • **contractName**: *string* -*Defined in [ethereum-types/src/index.ts:667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L667)* +*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L675)* ___ @@ -26922,7 +17109,7 @@ ___ • **networks**: *[ContractNetworks](#class-contractnetworks)* -*Defined in [ethereum-types/src/index.ts:668](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L668)* +*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L676)* ___ @@ -26930,7 +17117,7 @@ ___ • **schemaVersion**: *string* -*Defined in [ethereum-types/src/index.ts:666](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L666)* +*Defined in [ethereum-types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L674)* ___ @@ -26940,7 +17127,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* -*Defined in [ethereum-types/src/index.ts:639](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L639)* +*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: @@ -26954,7 +17141,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L642)* +*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L650)* ___ @@ -26964,7 +17151,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* -*Defined in [ethereum-types/src/index.ts:634](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L634)* +*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: @@ -26981,7 +17168,7 @@ ___ • **address**: *string* -*Defined in [ethereum-types/src/index.ts:546](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L546)* +*Defined in [ethereum-types/src/index.ts:554](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L554)* ___ @@ -26989,7 +17176,7 @@ Args • **constructorArgs**: *string* -*Defined in [ethereum-types/src/index.ts:550](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L550)* +*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L558)* ___ @@ -26997,7 +17184,7 @@ ___ • **links**: *object* -*Defined in [ethereum-types/src/index.ts:547](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L547)* +*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: @@ -27021,7 +17208,7 @@ ___ • **compiler**: *[CompilerOpts](#class-compileropts)* -*Defined in [ethereum-types/src/index.ts:633](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L633)* +*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L641)* ___ @@ -27029,7 +17216,7 @@ ___ • **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* -*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L643)* +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L651)* ___ @@ -27037,7 +17224,7 @@ ___ • **sourceCodes**: *object* -*Defined in [ethereum-types/src/index.ts:639](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L639)* +*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: @@ -27049,7 +17236,7 @@ ___ • **sourceTreeHashHex**: *string* -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L642)* +*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L650)* ___ @@ -27057,7 +17244,7 @@ ___ • **sources**: *object* -*Defined in [ethereum-types/src/index.ts:634](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L634)* +*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: @@ -27074,7 +17261,7 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L131)* +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L137)* ___ @@ -27082,7 +17269,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L129)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -27090,7 +17277,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L130)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -27110,7 +17297,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -27118,7 +17305,7 @@ ___ • **args**: *`A`* -*Defined in [ethereum-types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L411)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* ___ @@ -27128,7 +17315,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -27138,7 +17325,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -27148,7 +17335,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -27156,7 +17343,7 @@ ___ • **event**: *string* -*Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L410)* +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* ___ @@ -27166,7 +17353,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -27176,7 +17363,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -27186,7 +17373,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -27196,126 +17383,11 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)* +*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:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* - -___ - -### args - -• **args**: *`A`* - -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* - -*Defined in [ethereum-types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L411)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* - -*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* - -*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* - -___ - -### data - -• **data**: *string* - -*Inherited from [LogEntry](#interface-logentry).[data](#data)* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* - -___ - -### event - -• **event**: *string* - -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* - -*Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L410)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* - -*Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* - -___ - -### removed - -• **removed**: *boolean* - -*Defined in [ethereum-types/src/index.ts:415](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L415)* - -___ - -### topics - -• **topics**: *string[]* - -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* - -*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* - -*Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)* - -
# Interface: DevdocOutput @@ -27326,7 +17398,7 @@ ___ • **author**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:620](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L620)* +*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L628)* ___ @@ -27334,7 +17406,7 @@ ___ • **methods**: *object* -*Defined in [ethereum-types/src/index.ts:621](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L621)* +*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: @@ -27346,7 +17418,7 @@ ___ • **title**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L619)* +*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L627)*
@@ -27359,7 +17431,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -27367,7 +17439,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -27391,7 +17463,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -27417,7 +17489,7 @@ Name | Type | • **object**: *string* -*Defined in [ethereum-types/src/index.ts:614](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L614)* +*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L622)* ___ @@ -27425,7 +17497,7 @@ ___ • **sourceMap**: *string* -*Defined in [ethereum-types/src/index.ts:615](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L615)* +*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L623)*
@@ -27438,7 +17510,7 @@ ___ • **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:609](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L609)* +*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L617)* ___ @@ -27446,7 +17518,7 @@ ___ • **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:610](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L610)* +*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L618)*
@@ -27459,7 +17531,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L112)* +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L112)* ___ @@ -27467,7 +17539,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L111)* +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L111)*
@@ -27482,7 +17554,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/23602ec6b/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:** @@ -27506,7 +17578,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L324)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* ___ @@ -27514,7 +17586,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L325)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* ___ @@ -27522,7 +17594,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L323)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* ___ @@ -27530,7 +17602,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L322)* +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)*
@@ -27543,7 +17615,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* ___ @@ -27551,7 +17623,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)*
@@ -27564,7 +17636,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L337)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* ___ @@ -27572,7 +17644,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* ___ @@ -27580,7 +17652,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* ___ @@ -27588,171 +17660,13 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L334)* +*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:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* - -___ - -### data - -• **data**: *string* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* - -___ - -### topics - -• **topics**: *string[]* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)* - -
- -# Interface: LogEntryEvent - - -## Properties - -### address - -• **address**: *string* - -*Inherited from [LogEntry](#interface-logentry).[address](#address)* - -*Defined in [ethereum-types/src/index.ts:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* - -*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* - -___ - -### blockNumber - -• **blockNumber**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* - -*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* - -___ - -### data - -• **data**: *string* - -*Inherited from [LogEntry](#interface-logentry).[data](#data)* - -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* - -___ - -### logIndex - -• **logIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* - -*Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* - -___ - -### removed - -• **removed**: *boolean* - -*Defined in [ethereum-types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L419)* - -___ - -### topics - -• **topics**: *string[]* - -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* - -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* - -*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* - -___ - -### transactionIndex - -• **transactionIndex**: *number | null* - -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* - -*Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)* - -
# Interface: LogWithDecodedArgs <**ArgsType**> @@ -27769,7 +17683,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L434)* ___ @@ -27779,7 +17693,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [ethereum-types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L411)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L417)* ___ @@ -27789,7 +17703,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L432)* ___ @@ -27799,7 +17713,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L433)* ___ @@ -27809,7 +17723,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L435)* ___ @@ -27819,7 +17733,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L410)* +*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L416)* ___ @@ -27829,7 +17743,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* +*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L429)* ___ @@ -27839,7 +17753,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L436)* ___ @@ -27849,7 +17763,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L431)* ___ @@ -27859,7 +17773,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L430)*
@@ -27872,7 +17786,7 @@ ___ • **constant**: *boolean* -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L94)* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L94)* ___ @@ -27880,7 +17794,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L92)* +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L92)* ___ @@ -27888,7 +17802,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L91)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L91)* ___ @@ -27896,7 +17810,7 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L93)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L93)* ___ @@ -27904,7 +17818,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L96)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L96)* ___ @@ -27912,7 +17826,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L95)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L95)* ___ @@ -27920,7 +17834,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L90)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L90)*
@@ -27933,7 +17847,7 @@ ___ • **enabled**: *boolean* -*Defined in [ethereum-types/src/index.ts:700](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L700)* +*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L708)* ___ @@ -27941,7 +17855,7 @@ ___ • **runs**? : *undefined | number* -*Defined in [ethereum-types/src/index.ts:701](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L701)* +*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L709)*
@@ -27949,6 +17863,35 @@ ___ +# 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)* + +
+ @@ -27964,7 +17907,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [ethereum-types/src/index.ts:556](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L556)* +*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L564)* ___ @@ -27972,7 +17915,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L558)* +*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L566)* ___ @@ -27980,7 +17923,7 @@ ___ • **evm**: *[EvmOutput](#class-evmoutput)* -*Defined in [ethereum-types/src/index.ts:557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L557)* +*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L565)*
@@ -27990,949 +17933,8 @@ ___ -# Class: CoordinatorContract -## Constructors - - - -\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[CoordinatorContract](#class-coordinatorcontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1452](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1452)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[CoordinatorContract](#class-coordinatorcontract)* - -## Properties - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:25 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:26 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - -Defined in base-contract/lib/src/index.d.ts:38 - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1158](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1158)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1111](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1111)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1078](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1078)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:37 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### EIP712_COORDINATOR_DOMAIN_HASH - -#### ▪ **EIP712_COORDINATOR_DOMAIN_HASH**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1005](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1005)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1011](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1011)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1070](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1070)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1058](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1058)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1048](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1048)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### EIP712_EXCHANGE_DOMAIN_HASH - -#### ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:652](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L652)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:658](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L658)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:717](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L717)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:705](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L705)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *void* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:695](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L695)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### assertValidCoordinatorApprovals - -#### ▪ **assertValidCoordinatorApprovals**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:729](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L729)* - -Validates that the 0x transaction has been approved by all of the feeRecipients -that correspond to each order in the transaction's Exchange calldata. - -#### callAsync - -▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:744](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L744)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`transaction` | object | - | 0x transaction containing salt, signerAddress, and data. | -`txOrigin` | string | - | Required signer of Ethereum transaction calling this function. | -`transactionSignature` | string | - | Proof that the transaction has been signed by the signer. | -`approvalExpirationTimeSeconds` | `BigNumber`[] | - | Array of expiration times in seconds for which each corresponding approval signature expires. | -`approvalSignatures` | string[] | - | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L860)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string, string, `BigNumber`[], string[]]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:842](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L842)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[object, string, string, `BigNumber`[], string[]]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:813](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L813)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | object | 0x transaction containing salt, signerAddress, and data. | -`txOrigin` | string | Required signer of Ethereum transaction calling this function. | -`transactionSignature` | string | Proof that the transaction has been signed by the signer. | -`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | -`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### decodeOrdersFromFillData - -#### ▪ **decodeOrdersFromFillData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:873](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L873)* - -Decodes the orders from Exchange calldata representing any fill method. - -#### callAsync - -▸ **callAsync**(`data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:881](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L881)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`data` | string | - | Exchange calldata representing a fill method. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise>`* - -The orders from the Exchange calldata. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:967](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L967)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *`Array`* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:955](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L955)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`data`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:944](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L944)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`data` | string | Exchange calldata representing a fill method. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### executeTransaction - -#### ▪ **executeTransaction**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L321)* - -Executes a 0x transaction that has been signed by the feeRecipients that correspond to each order in the transaction's Exchange calldata. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:399](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L399)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | object | 0x transaction containing salt, signerAddress, and data. | -`txOrigin` | string | Required signer of Ethereum transaction calling this function. | -`transactionSignature` | string | Proof that the transaction has been signed by the signer. | -`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | -`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:526](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L526)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`transaction` | object | - | 0x transaction containing salt, signerAddress, and data. | -`txOrigin` | string | - | Required signer of Ethereum transaction calling this function. | -`transactionSignature` | string | - | Proof that the transaction has been signed by the signer. | -`approvalExpirationTimeSeconds` | `BigNumber`[] | - | Array of expiration times in seconds for which each corresponding approval signature expires. | -`approvalSignatures` | string[] | - | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:448](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L448)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | object | 0x transaction containing salt, signerAddress, and data. | -`txOrigin` | string | Required signer of Ethereum transaction calling this function. | -`transactionSignature` | string | Proof that the transaction has been signed by the signer. | -`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | -`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:642](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L642)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *void* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string, string, `BigNumber`[], string[]]* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:624](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L624)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *[object, string, string, `BigNumber`[], string[]]* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:595](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L595)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | object | 0x transaction containing salt, signerAddress, and data. | -`txOrigin` | string | Required signer of Ethereum transaction calling this function. | -`transactionSignature` | string | Proof that the transaction has been signed by the signer. | -`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | -`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:337](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L337)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | object | 0x transaction containing salt, signerAddress, and data. | -`txOrigin` | string | Required signer of Ethereum transaction calling this function. | -`transactionSignature` | string | Proof that the transaction has been signed by the signer. | -`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | -`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### validateAndSendTransactionAsync - -▸ **validateAndSendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:486](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L486)* - -**Parameters:** - -Name | Type | ------- | ------ | -`transaction` | object | -`txOrigin` | string | -`transactionSignature` | string | -`approvalExpirationTimeSeconds` | `BigNumber`[] | -`approvalSignatures` | string[] | -`txData?` | `Partial` \| undefined | - -**Returns:** *`Promise`* - -___ - -### getCoordinatorApprovalHash - -#### ▪ **getCoordinatorApprovalHash**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:208](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L208)* - -Calculated the EIP712 hash of the Coordinator approval mesasage using the domain separator of this contract. - -#### callAsync - -▸ **callAsync**(`approval`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L217)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`approval` | object | - | Coordinator approval message containing the transaction hash, transaction signature, and expiration of the approval. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -EIP712 hash of the Coordinator approval message with the domain separator of this contract. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:310](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L310)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:286](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L286)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *object* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`approval`: object): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:268](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L268)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`approval` | object | Coordinator approval message containing the transaction hash, transaction signature, and expiration of the approval. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getSignerAddress - -#### ▪ **getSignerAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L34)* - -Recovers the address of a signer given a hash and signature. - -#### callAsync - -▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L42)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Any 32 byte hash. | -`signature` | string | - | Proof that the hash has been signed by signer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:105](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L105)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:93](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L93)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *string* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L78)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`hash` | string | Any 32 byte hash. | -`signature` | string | Proof that the hash has been signed by signer. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -___ - -### getTransactionHash - -#### ▪ **getTransactionHash**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:116](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L116)* - -Calculates the EIP712 hash of a 0x transaction using the domain separator of the Exchange contract. - -#### callAsync - -▸ **callAsync**(`transaction`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L124)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`transaction` | object | - | 0x transaction containing salt, signerAddress, and data. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -EIP712 hash of the transaction with the domain separator of this contract. - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:197](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L197)* - -Decode the ABI-encoded return data from a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`returnData` | string | the data returned after transaction execution | - -**Returns:** *string* - -An array representing the output results in order. Keynames of nested structs are preserved. - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L181)* - -Decode the ABI-encoded transaction data into its input arguments - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | string | The ABI-encoded transaction data | - -**Returns:** *object* - -An array representing the input arguments in order. Keynames of nested structs are preserved. - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transaction`: object): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L168)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | object | 0x transaction containing salt, signerAddress, and data. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -
- @@ -28950,7 +17952,7 @@ The ABI encoded transaction data as a string *Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L141)* ___ @@ -28960,7 +17962,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L129)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -28970,7 +17972,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L130)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -28985,7 +17987,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L387)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -28993,7 +17995,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -29003,7 +18005,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L385)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -29013,7 +18015,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L386)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -29023,7 +18025,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L388)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -29033,7 +18035,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L383)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -29043,7 +18045,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L384)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L390)*
@@ -29058,7 +18060,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L387)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L393)* ___ @@ -29068,7 +18070,7 @@ ___ *Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L398)* ___ @@ -29078,7 +18080,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L385)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L391)* ___ @@ -29088,7 +18090,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L386)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L392)* ___ @@ -29098,7 +18100,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L388)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L394)* ___ @@ -29108,7 +18110,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L383)* +*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L389)* ___ @@ -29118,7 +18120,7 @@ ___ *Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L442)*
@@ -29135,7 +18137,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/23602ec6b/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:** @@ -29151,7 +18153,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/23602ec6b/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:** @@ -29177,7 +18179,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/23602ec6b/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:** @@ -29203,7 +18205,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/23602ec6b/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:** @@ -29229,7 +18231,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ @@ -29237,7 +18239,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ @@ -29245,7 +18247,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -29253,7 +18255,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L34)* +*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`* @@ -29263,7 +18265,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/23602ec6b/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:** @@ -29280,7 +18282,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L33)* +*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* @@ -29303,7 +18305,7 @@ ___ -Defined in ethereum-types/lib/index.d.ts:262 +Defined in ethereum-types/lib/index.d.ts:267 ___ @@ -29313,7 +18315,7 @@ ___ -Defined in ethereum-types/lib/index.d.ts:263 +Defined in ethereum-types/lib/index.d.ts:268 ___ @@ -29323,7 +18325,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -29333,7 +18335,7 @@ ___ -Defined in ethereum-types/lib/index.d.ts:260 +Defined in ethereum-types/lib/index.d.ts:265
@@ -29384,6 +18386,33 @@ Defined in ethereum-types/lib/index.d.ts:260 + + + +# Interface: DecodedLogEvent <**ArgsType**> + +## Type parameters + +▪ **ArgsType**: *`DecodedLogArgs`* + + +## Properties + +### isRemoved + +• **isRemoved**: *boolean* + +*Defined in [types/src/index.ts:853](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L853)* + +___ + +### log + +• **log**: *`LogWithDecodedArgs`* + +*Defined in [types/src/index.ts:854](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L854)* + +
@@ -29396,7 +18425,7 @@ Defined in ethereum-types/lib/index.d.ts:260 • **assetData**: *[AssetData](#assetdata)* -*Defined in [types/src/index.ts:223](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L223)* +*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L219)* ___ @@ -29404,7 +18433,7 @@ ___ • **beginAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L225)* +*Defined in [types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L221)* ___ @@ -29412,7 +18441,7 @@ ___ • **beginTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L224)* +*Defined in [types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L220)*
@@ -29429,7 +18458,7 @@ Elliptic Curve signature • **r**: *string* -*Defined in [types/src/index.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L68)* +*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L62)* ___ @@ -29437,7 +18466,7 @@ ___ • **s**: *string* -*Defined in [types/src/index.ts:69](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L69)* +*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L63)* ___ @@ -29445,12 +18474,47 @@ ___ • **v**: *number* -*Defined in [types/src/index.ts:67](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L67)* +*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L61)*
+# Interface: EIP712DomainWithDefaultSchema +## Properties + +### chainId + +• **chainId**: *number* + +*Defined in [types/src/index.ts:802](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L802)* + +___ + +### `Optional` name + +• **name**? : *undefined | string* + +*Defined in [types/src/index.ts:800](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L800)* + +___ + +### verifyingContract + +• **verifyingContract**: *string* + +*Defined in [types/src/index.ts:803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L803)* + +___ + +### `Optional` version + +• **version**? : *undefined | string* + +*Defined in [types/src/index.ts:801](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L801)* + +
+ @@ -29466,7 +18530,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L187)* +*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L183)* ___ @@ -29474,7 +18538,7 @@ ___ • **callbackData**: *string* -*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L191)* +*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L187)* ___ @@ -29482,7 +18546,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:188](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L188)* +*Defined in [types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L184)* ___ @@ -29490,7 +18554,7 @@ ___ • **tokenIds**: *`BigNumber`[]* -*Defined in [types/src/index.ts:189](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L189)* +*Defined in [types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L185)* ___ @@ -29498,7 +18562,7 @@ ___ • **tokenValues**: *`BigNumber`[]* -*Defined in [types/src/index.ts:190](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L190)* +*Defined in [types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L186)*
@@ -29513,7 +18577,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:176](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L176)* +*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L172)* ___ @@ -29521,7 +18585,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L177)* +*Defined in [types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L173)*
@@ -29534,7 +18598,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L181)* +*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L177)* ___ @@ -29542,7 +18606,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:182](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L182)* +*Defined in [types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L178)* ___ @@ -29550,7 +18614,7 @@ ___ • **tokenId**: *`BigNumber`* -*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L183)* +*Defined in [types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L179)*
@@ -29564,6 +18628,42 @@ ___ +# Interface: IndexedFilterValues + + +## Hierarchy + +* **IndexSignature** + + +## Properties + +### keyName + +• **keyName**: *string* + +*Defined in [types/src/index.ts:679](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L679)* + +___ + +### keyType + +• **keyType**: *[Type](#class-type)* + +*Defined in [types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L680)* + +___ + +### valueName + +• **valueName**: *string* + +*Defined in [types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L681)* + +
+ + + # Interface: MultiAssetData @@ -29575,7 +18675,7 @@ ___ • **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L212)* +*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L208)* ___ @@ -29583,7 +18683,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:211](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L211)* +*Defined in [types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L207)* ___ @@ -29591,7 +18691,7 @@ ___ • **nestedAssetData**: *string[]* -*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L213)* +*Defined in [types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L209)*
@@ -29604,7 +18704,7 @@ ___ • **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:218](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L218)* +*Defined in [types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L214)* ___ @@ -29612,7 +18712,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L217)* +*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L213)* ___ @@ -29620,7 +18720,7 @@ ___ • **nestedAssetData**: *[SingleAssetData](#singleassetdata)[]* -*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L219)* +*Defined in [types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L215)*
@@ -29665,13 +18765,23 @@ ___ ## Properties +### chainId + +• **chainId**: *number* + +*Inherited from [Order](#interface-order).[chainId](#chainid)* + +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* + +___ + ### exchangeAddress • **exchangeAddress**: *string* *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -29681,7 +18791,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -29691,7 +18801,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -29701,7 +18811,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L11)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -29711,7 +18821,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -29721,7 +18831,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -29731,7 +18841,17 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L13)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* + +___ + +### makerFeeAssetData + +• **makerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* + +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -29741,7 +18861,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -29751,7 +18871,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L10)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -29759,7 +18879,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L41)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -29769,7 +18889,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L12)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -29779,7 +18899,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -29789,7 +18909,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -29799,7 +18919,17 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* + +___ + +### takerFeeAssetData + +• **takerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* + +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -29814,7 +18944,37 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)* -*Defined in [types/src/index.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L56)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* + +___ + +### domain + +• **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* + +*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[domain](#domain)* + +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* + +___ + +### expirationTimeSeconds + +• **expirationTimeSeconds**: *`BigNumber`* + +*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[expirationTimeSeconds](#expirationtimeseconds)* + +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* + +___ + +### gasPrice + +• **gasPrice**: *`BigNumber`* + +*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[gasPrice](#gasprice)* + +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* ___ @@ -29824,7 +18984,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)* -*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L54)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* ___ @@ -29832,7 +18992,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L60)* +*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L54)* ___ @@ -29842,17 +19002,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)* -*Defined in [types/src/index.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L55)* - -___ - -### verifyingContractAddress - -• **verifyingContractAddress**: *string* - -*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[verifyingContractAddress](#verifyingcontractaddress)* - -*Defined in [types/src/index.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L53)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)*
@@ -29865,7 +19015,7 @@ ___ • **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)* -*Defined in [types/src/index.ts:739](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L739)* +*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L748)* ___ @@ -29873,7 +19023,7 @@ ___ • **contractName**: *string* -*Defined in [types/src/index.ts:738](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L738)* +*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L747)* ___ @@ -29881,7 +19031,7 @@ ___ • **networks**: *`ContractNetworks`* -*Defined in [types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L740)* +*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L749)* ___ @@ -29889,7 +19039,7 @@ ___ • **schemaVersion**: *string* -*Defined in [types/src/index.ts:737](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L737)* +*Defined in [types/src/index.ts:746](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L746)*
@@ -29902,7 +19052,7 @@ ___ • **object**: *string* -*Defined in [types/src/index.ts:754](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L754)* +*Defined in [types/src/index.ts:763](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L763)*
@@ -29915,7 +19065,7 @@ ___ • **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)* -*Defined in [types/src/index.ts:750](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L750)* +*Defined in [types/src/index.ts:759](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L759)*
@@ -29928,7 +19078,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [types/src/index.ts:744](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L744)* +*Defined in [types/src/index.ts:753](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L753)* ___ @@ -29936,7 +19086,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [types/src/index.ts:746](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L746)* +*Defined in [types/src/index.ts:755](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L755)* ___ @@ -29944,7 +19094,7 @@ ___ • **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)* -*Defined in [types/src/index.ts:745](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L745)* +*Defined in [types/src/index.ts:754](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L754)*
@@ -29961,7 +19111,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:195](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L195)* +*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L191)* ___ @@ -29969,7 +19119,7 @@ ___ • **callResultHash**: *string* -*Defined in [types/src/index.ts:198](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L198)* +*Defined in [types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L194)* ___ @@ -29977,7 +19127,7 @@ ___ • **callTarget**: *string* -*Defined in [types/src/index.ts:196](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L196)* +*Defined in [types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L192)* ___ @@ -29985,7 +19135,7 @@ ___ • **staticCallData**: *string* -*Defined in [types/src/index.ts:197](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L197)* +*Defined in [types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L193)*
@@ -30026,7 +19176,7 @@ Validator signature components • **signature**: *string* -*Defined in [types/src/index.ts:77](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L77)* +*Defined in [types/src/index.ts:71](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L71)* ___ @@ -30034,7 +19184,7 @@ ___ • **validatorAddress**: *string* -*Defined in [types/src/index.ts:76](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L76)* +*Defined in [types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L70)*
@@ -30049,7 +19199,31 @@ ZeroExTransaction for use with 0x Exchange executeTransaction • **data**: *string* -*Defined in [types/src/index.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L56)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* + +___ + +### domain + +• **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* + +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* + +___ + +### expirationTimeSeconds + +• **expirationTimeSeconds**: *`BigNumber`* + +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* + +___ + +### gasPrice + +• **gasPrice**: *`BigNumber`* + +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* ___ @@ -30057,7 +19231,7 @@ ___ • **salt**: *`BigNumber`* -*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L54)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* ___ @@ -30065,15 +19239,7 @@ ___ • **signerAddress**: *string* -*Defined in [types/src/index.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L55)* - -___ - -### verifyingContractAddress - -• **verifyingContractAddress**: *string* - -*Defined in [types/src/index.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L53)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)*
@@ -30083,83 +19249,6 @@ ___ -
- - - - -## Type aliases - -### CoordinatorRegistryEventArgs - -Ƭ **CoordinatorRegistryEventArgs**: *[CoordinatorRegistryCoordinatorEndpointSetEventArgs](#interface-coordinatorregistrycoordinatorendpointseteventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L34)* - -
- - - -
- - - - -## Type aliases - -### DummyERC20TokenEventArgs - -Ƭ **DummyERC20TokenEventArgs**: *[DummyERC20TokenTransferEventArgs](#interface-dummyerc20tokentransfereventargs) | [DummyERC20TokenApprovalEventArgs](#interface-dummyerc20tokenapprovaleventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L34)* - -
- - - - -## Type aliases - -### DummyERC721TokenEventArgs - -Ƭ **DummyERC721TokenEventArgs**: *[DummyERC721TokenTransferEventArgs](#interface-dummyerc721tokentransfereventargs) | [DummyERC721TokenApprovalEventArgs](#interface-dummyerc721tokenapprovaleventargs) | [DummyERC721TokenApprovalForAllEventArgs](#interface-dummyerc721tokenapprovalforalleventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L34)* - -
- - - -
- - - - -## Type aliases - -### ERC1155ProxyEventArgs - -Ƭ **ERC1155ProxyEventArgs**: *[ERC1155ProxyAuthorizedAddressAddedEventArgs](#interface-erc1155proxyauthorizedaddressaddedeventargs) | [ERC1155ProxyAuthorizedAddressRemovedEventArgs](#interface-erc1155proxyauthorizedaddressremovedeventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L34)* - -
- - - - -## Type aliases - -### ERC20ProxyEventArgs - -Ƭ **ERC20ProxyEventArgs**: *[ERC20ProxyAuthorizedAddressAddedEventArgs](#interface-erc20proxyauthorizedaddressaddedeventargs) | [ERC20ProxyAuthorizedAddressRemovedEventArgs](#interface-erc20proxyauthorizedaddressremovedeventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L34)* - -
- - - ## Type aliases @@ -30167,20 +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/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L34)* - -
- - - - -## Type aliases - -### ERC721ProxyEventArgs - -Ƭ **ERC721ProxyEventArgs**: *[ERC721ProxyAuthorizedAddressAddedEventArgs](#interface-erc721proxyauthorizedaddressaddedeventargs) | [ERC721ProxyAuthorizedAddressRemovedEventArgs](#interface-erc721proxyauthorizedaddressremovedeventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L34)* +*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)*
@@ -30191,9 +19267,9 @@ ___ ### ERC721TokenEventArgs -Ƭ **ERC721TokenEventArgs**: *[ERC721TokenTransferEventArgs](#interface-erc721tokentransfereventargs) | [ERC721TokenApprovalEventArgs](#interface-erc721tokenapprovaleventargs) | [ERC721TokenApprovalForAllEventArgs](#interface-erc721tokenapprovalforalleventargs)* +Ƭ **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/23602ec6b/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)*
@@ -30204,9 +19280,9 @@ ___ ### ExchangeEventArgs -Ƭ **ExchangeEventArgs**: *[ExchangeSignatureValidatorApprovalEventArgs](#interface-exchangesignaturevalidatorapprovaleventargs) | [ExchangeFillEventArgs](#interface-exchangefilleventargs) | [ExchangeCancelEventArgs](#interface-exchangecanceleventargs) | [ExchangeCancelUpToEventArgs](#interface-exchangecanceluptoeventargs) | [ExchangeAssetProxyRegisteredEventArgs](#interface-exchangeassetproxyregisteredeventargs)* +Ƭ **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/23602ec6b/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)*
@@ -30220,14 +19296,6 @@ ___ -
- - - -
- - - ## Type aliases @@ -30235,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/23602ec6b/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)*
@@ -30248,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/23602ec6b/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)*
@@ -30261,7 +19329,7 @@ ___ ▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)* -*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L128)* +*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 @@ -30278,60 +19346,6 @@ Name | Type | Description | The set of addresses for contracts which have been deployed on the given networkId. -___ - -### getNetworkIdByExchangeAddressOrThrow - -▸ **getNetworkIdByExchangeAddressOrThrow**(`exchangeAddress`: string): *[NetworkId](#enumeration-networkid)* - -*Defined in [contract-addresses/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L142)* - -Uses a given exchange address to look up the network id that the exchange contract is deployed -on. Only works for Ethereum mainnet or a supported testnet. Throws if the exchange address -does not correspond to a known deployed exchange contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeAddress` | string | The exchange address of concern | - -**Returns:** *[NetworkId](#enumeration-networkid)* - -The network ID on which the exchange contract is deployed - -
- - - -
- - - -
- - - - -## Type aliases - -### EventCallback - -Ƭ **EventCallback**: *function* - -*Defined in [contract-wrappers/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L11)* - -#### Type declaration: - -▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`err` | null \| `Error` | -`log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› | -
@@ -30341,9 +19355,9 @@ Name | Type | ### AbiDefinition -Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi)* +Ƭ **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/23602ec6b/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)* ___ @@ -30351,7 +19365,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [ethereum-types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L475)* +*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L483)* ___ @@ -30359,7 +19373,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L84)* ___ @@ -30367,7 +19381,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L78)* +*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L78)* ___ @@ -30375,15 +19389,17 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [ethereum-types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L460)* +*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L468)* ___ + + ### EIP1193Event Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L70)* +*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 @@ -30398,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/23602ec6b/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)* ___ @@ -30406,7 +19422,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L3)* +*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: @@ -30427,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:517](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L517)* +*Defined in [ethereum-types/src/index.ts:525](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L525)* ___ @@ -30435,23 +19451,17 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [ethereum-types/src/index.ts:553](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L553)* +*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L561)* ___ -### RawLog -Ƭ **RawLog**: *[LogEntry](#interface-logentry)* - -*Defined in [ethereum-types/src/index.ts:467](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L467)* - -___ ### StateMutability Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L85)* ___ @@ -30459,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/23602ec6b/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. @@ -30474,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/23602ec6b/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)*
@@ -30487,13 +19497,13 @@ ___ #### ▪ **assetDataUtils**: *object* -*Defined in [order-utils/src/asset_data_utils.ts:23](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L23)* +*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/23602ec6b/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. @@ -30509,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/23602ec6b/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. @@ -30525,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/23602ec6b/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. @@ -30541,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/23602ec6b/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. @@ -30557,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/23602ec6b/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. @@ -30573,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/23602ec6b/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. @@ -30589,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/23602ec6b/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 @@ -30607,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/23602ec6b/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 @@ -30625,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/23602ec6b/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 @@ -30645,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/23602ec6b/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. @@ -30663,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/23602ec6b/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 @@ -30681,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/23602ec6b/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 @@ -30699,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/23602ec6b/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 @@ -30717,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/23602ec6b/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) @@ -30735,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/23602ec6b/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 @@ -30753,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/23602ec6b/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 @@ -30775,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/23602ec6b/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. @@ -30797,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/23602ec6b/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. @@ -30816,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/23602ec6b/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. @@ -30836,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/23602ec6b/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. @@ -30856,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/23602ec6b/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 @@ -30876,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/23602ec6b/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 @@ -30892,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/23602ec6b/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 @@ -30908,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/23602ec6b/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 @@ -30924,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/23602ec6b/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 @@ -30940,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/23602ec6b/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 @@ -30956,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/23602ec6b/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. @@ -30979,13 +19989,13 @@ Name | Type | Description | #### ▪ **orderHashUtils**: *object* -*Defined in [order-utils/src/order_hash.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_hash.ts#L12)* +*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/23602ec6b/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 @@ -31003,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/23602ec6b/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. @@ -31021,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/23602ec6b/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. @@ -31048,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/23602ec6b/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 @@ -31069,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/23602ec6b/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/23602ec6b/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. @@ -31093,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/23602ec6b/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 @@ -31111,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/23602ec6b/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. @@ -31130,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/23602ec6b/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. @@ -31150,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/23602ec6b/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. @@ -31171,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/23602ec6b/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. @@ -31192,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/23602ec6b/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. @@ -31212,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/23602ec6b/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. @@ -31232,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/23602ec6b/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` @@ -31253,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/23602ec6b/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 @@ -31274,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/23602ec6b/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 @@ -31296,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/23602ec6b/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 @@ -31318,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/23602ec6b/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 @@ -31339,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/23602ec6b/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 @@ -31357,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/23602ec6b/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 @@ -31382,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/23602ec6b/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/23602ec6b/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. @@ -31406,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/23602ec6b/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. @@ -31424,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/23602ec6b/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. @@ -31459,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/23602ec6b/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: @@ -31473,7 +20483,7 @@ ___ Ƭ **ErrorCallback**: *function* -*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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: @@ -31505,7 +20515,7 @@ ___ Ƭ **AssetData**: *[SingleAssetData](_types_src_index_.md#singleassetdata) | [MultiAssetData](#interface-multiassetdata) | [MultiAssetDataWithRecursiveDecoding](#interface-multiassetdatawithrecursivedecoding)* -*Defined in [types/src/index.ts:228](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L228)* +*Defined in [types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L224)* ___ @@ -31515,6 +20525,25 @@ ___ +### 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`*› | + +___ + @@ -31527,7 +20556,11 @@ ___ Ƭ **SingleAssetData**: *[ERC20AssetData](#interface-erc20assetdata) | [ERC721AssetData](#interface-erc721assetdata) | [ERC1155AssetData](#interface-erc1155assetdata) | [StaticCallAssetData](#interface-staticcallassetdata)* -*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L208)* +*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 1e46d8b4ba..d1fb15b3c8 100644 --- a/packages/abi-gen-wrappers/CHANGELOG.json +++ b/packages/abi-gen-wrappers/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Hardcode bytecode for local EVM execution", "pr": 2198 } - ] + ], + "timestamp": 1570135330 }, { "version": "5.3.2", diff --git a/packages/abi-gen-wrappers/CHANGELOG.md b/packages/abi-gen-wrappers/CHANGELOG.md index 420f9e76d2..fc27af744c 100644 --- a/packages/abi-gen-wrappers/CHANGELOG.md +++ b/packages/abi-gen-wrappers/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v5.4.0-beta.0 - _October 3, 2019_ + + * Use V3 contracts (#2181) + * Hardcode bytecode for local EVM execution (#2198) + ## v5.3.2 - _September 17, 2019_ * Redirect `callAsync` to use local EVM instead of eth_call for pure functions (#2108) @@ -47,7 +52,9 @@ CHANGELOG ## v4.3.0 - _May 10, 2019_ + * Update Coordinator and Exchange wrappers (#1742) * Update wrapper functions to expose `awaitTransactionSuccessAsync()` methods (#1797) + * Update wrappers to automatically throw `RevertError` types when possible. (#1819) ## v4.2.0 - _April 11, 2019_ diff --git a/packages/abi-gen/CHANGELOG.json b/packages/abi-gen/CHANGELOG.json index b4230a887c..de66262620 100644 --- a/packages/abi-gen/CHANGELOG.json +++ b/packages/abi-gen/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "version": "4.2.1", diff --git a/packages/abi-gen/CHANGELOG.md b/packages/abi-gen/CHANGELOG.md index 81a34c78f5..d39e9f04dd 100644 --- a/packages/abi-gen/CHANGELOG.md +++ b/packages/abi-gen/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v4.3.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v4.2.1 - _September 17, 2019_ * Redirect to `evmExecAsync` to use local EVM instead of eth_call for pure functions (#2108) diff --git a/packages/assert/CHANGELOG.json b/packages/assert/CHANGELOG.json index 86197fa9d0..6989684858 100644 --- a/packages/assert/CHANGELOG.json +++ b/packages/assert/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/packages/assert/CHANGELOG.md b/packages/assert/CHANGELOG.md index 6a02e6afaa..00a806a0fd 100644 --- a/packages/assert/CHANGELOG.md +++ b/packages/assert/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.2.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v2.1.6 - _September 17, 2019_ * Dependencies updated @@ -32,6 +36,7 @@ CHANGELOG ## v2.1.0 - _July 13, 2019_ * Add new assertions: `isArray`, `isBlockParam` and `isNumberOrBigNumber` (#1823) + * Add `isNumberLike()` assertion (#1819) ## v2.0.10 - _May 10, 2019_ diff --git a/packages/asset-buyer/CHANGELOG.json b/packages/asset-buyer/CHANGELOG.json index ed8dad3442..9d121469fe 100644 --- a/packages/asset-buyer/CHANGELOG.json +++ b/packages/asset-buyer/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/packages/asset-buyer/CHANGELOG.md b/packages/asset-buyer/CHANGELOG.md index 5f518c3d44..1e4dbe84fb 100644 --- a/packages/asset-buyer/CHANGELOG.md +++ b/packages/asset-buyer/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v6.2.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v6.1.14 - _September 17, 2019_ * Dependencies updated diff --git a/packages/asset-buyer/docs/reference.mdx b/packages/asset-buyer/docs/reference.mdx index 98d8548cd9..bab6f5c6a6 100644 --- a/packages/asset-buyer/docs/reference.mdx +++ b/packages/asset-buyer/docs/reference.mdx @@ -1,70 +1,233 @@ -# Interface: ZeroExProvider - -The interface for the provider used internally by 0x libraries -Any property we use from any SupportedProvider should we explicitly -add here +# Class: AssetBuyer -## Properties +## Constructors -### `Optional` isMetaMask -• **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L31)* +\+ **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)* -### `Optional` isParity - -• **isParity**? : *undefined | false | true* - -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L32)* - -___ - -### `Optional` isZeroExProvider - -• **isZeroExProvider**? : *undefined | false | true* - -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L30)* - -## Methods - -### `Optional` enable - -▸ **enable**(): *`Promise`* - -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L34)* - -**Returns:** *`Promise`* - -___ - -### sendAsync - -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* - -*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L35)* +Instantiates a new AssetBuyer instance **Parameters:** -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | +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:** *void* +**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)* ___ -### `Optional` stop +### networkId -▸ **stop**(): *void* +• **networkId**: *number* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L33)* +*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)* -**Returns:** *void* +___ + +### 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
@@ -79,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/23602ec6b/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:** @@ -95,7 +258,7 @@ Name | Type | Description | • **amountAvailableToFill**: *`BigNumber`* -*Defined in [asset-buyer/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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. @@ -155,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/23602ec6b/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 @@ -175,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/23602ec6b/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 @@ -183,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/23602ec6b/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. @@ -203,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/23602ec6b/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. @@ -233,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/23602ec6b/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 @@ -254,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/23602ec6b/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)* ___ @@ -262,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/23602ec6b/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 @@ -270,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/23602ec6b/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. @@ -290,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/23602ec6b/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. @@ -317,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/23602ec6b/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)* ___ @@ -325,7 +488,7 @@ ___ • **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" -*Defined in [asset-buyer/src/types.ts:118](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -333,7 +496,7 @@ ___ • **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY" -*Defined in [asset-buyer/src/types.ts:119](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -341,7 +504,7 @@ ___ • **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE" -*Defined in [asset-buyer/src/types.ts:121](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -349,7 +512,7 @@ ___ • **NoAddressAvailable**: = "NO_ADDRESS_AVAILABLE" -*Defined in [asset-buyer/src/types.ts:120](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -357,7 +520,7 @@ ___ • **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND" -*Defined in [asset-buyer/src/types.ts:115](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -365,7 +528,7 @@ ___ • **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND" -*Defined in [asset-buyer/src/types.ts:116](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -373,7 +536,7 @@ ___ • **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" -*Defined in [asset-buyer/src/types.ts:123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -381,7 +544,7 @@ ___ • **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR" -*Defined in [asset-buyer/src/types.ts:117](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -389,7 +552,7 @@ ___ • **TransactionValueTooLow**: = "TRANSACTION_VALUE_TOO_LOW" -*Defined in [asset-buyer/src/types.ts:124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)*
@@ -423,7 +586,7 @@ ___ -
+ @@ -444,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/23602ec6b/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)* ___ @@ -452,7 +615,7 @@ ___ • **assetData**: *string* -*Defined in [asset-buyer/src/types.ts:47](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -460,7 +623,7 @@ ___ • **bestCaseQuoteInfo**: *[BuyQuoteInfo](#class-buyquoteinfo)* -*Defined in [asset-buyer/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -468,7 +631,7 @@ ___ • **feeOrders**: *`SignedOrder`[]* -*Defined in [asset-buyer/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -476,7 +639,7 @@ ___ • **feePercentage**? : *undefined | number* -*Defined in [asset-buyer/src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -484,7 +647,7 @@ ___ • **orders**: *`SignedOrder`[]* -*Defined in [asset-buyer/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -492,7 +655,7 @@ ___ • **worstCaseQuoteInfo**: *[BuyQuoteInfo](#class-buyquoteinfo)* -*Defined in [asset-buyer/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)*
@@ -511,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/23602ec6b/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)* ___ @@ -519,7 +682,7 @@ ___ • **feeRecipient**: *string* -*Defined in [asset-buyer/src/types.ts:97](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -527,7 +690,7 @@ ___ • **gasLimit**? : *undefined | number* -*Defined in [asset-buyer/src/types.ts:95](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -535,7 +698,7 @@ ___ • **gasPrice**? : *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -543,7 +706,7 @@ ___ • **takerAddress**? : *undefined | string* -*Defined in [asset-buyer/src/types.ts:94](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)*
@@ -560,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/23602ec6b/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)* ___ @@ -568,7 +731,7 @@ ___ • **feeEthAmount**: *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -576,7 +739,7 @@ ___ • **totalEthAmount**: *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:64](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)*
@@ -593,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/23602ec6b/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)* ___ @@ -601,7 +764,7 @@ ___ • **shouldForceOrderRefresh**: *boolean* -*Defined in [asset-buyer/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -609,7 +772,7 @@ ___ • **slippagePercentage**: *number* -*Defined in [asset-buyer/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)*
@@ -624,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/23602ec6b/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)* ___ @@ -632,7 +795,7 @@ ___ • **tokensAvailableInBaseUnits**: *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:140](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)*
@@ -652,13 +815,23 @@ remainingFillableMakerAssetAmount: The amount of the makerAsset that is availabl ## Properties +### chainId + +• **chainId**: *number* + + + +Defined in types/lib/index.d.ts:4 + +___ + ### exchangeAddress • **exchangeAddress**: *string* -Defined in types/lib/index.d.ts:14 +Defined in types/lib/index.d.ts:5 ___ @@ -668,7 +841,7 @@ ___ -Defined in types/lib/index.d.ts:16 +Defined in types/lib/index.d.ts:14 ___ @@ -678,7 +851,7 @@ ___ -Defined in types/lib/index.d.ts:15 +Defined in types/lib/index.d.ts:8 ___ @@ -688,7 +861,7 @@ ___ -Defined in types/lib/index.d.ts:5 +Defined in types/lib/index.d.ts:6 ___ @@ -698,7 +871,7 @@ ___ -Defined in types/lib/index.d.ts:9 +Defined in types/lib/index.d.ts:10 ___ @@ -708,7 +881,7 @@ ___ -Defined in types/lib/index.d.ts:11 +Defined in types/lib/index.d.ts:16 ___ @@ -718,7 +891,17 @@ ___ -Defined in types/lib/index.d.ts:7 +Defined in types/lib/index.d.ts:12 + +___ + +### makerFeeAssetData + +• **makerFeeAssetData**: *string* + + + +Defined in types/lib/index.d.ts:18 ___ @@ -726,7 +909,7 @@ ___ • **remainingFillableMakerAssetAmount**? : *`BigNumber`* -*Defined in [asset-buyer/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)* ___ @@ -736,7 +919,7 @@ ___ -Defined in types/lib/index.d.ts:13 +Defined in types/lib/index.d.ts:15 ___ @@ -746,7 +929,7 @@ ___ -Defined in types/lib/index.d.ts:4 +Defined in types/lib/index.d.ts:9 ___ @@ -756,7 +939,7 @@ ___ -Defined in types/lib/index.d.ts:33 +Defined in types/lib/index.d.ts:22 ___ @@ -766,7 +949,7 @@ ___ -Defined in types/lib/index.d.ts:6 +Defined in types/lib/index.d.ts:7 ___ @@ -776,7 +959,7 @@ ___ -Defined in types/lib/index.d.ts:10 +Defined in types/lib/index.d.ts:11 ___ @@ -786,7 +969,7 @@ ___ -Defined in types/lib/index.d.ts:12 +Defined in types/lib/index.d.ts:17 ___ @@ -796,7 +979,17 @@ ___ -Defined in types/lib/index.d.ts:8 +Defined in types/lib/index.d.ts:13 + +___ + +### takerFeeAssetData + +• **takerFeeAssetData**: *string* + + + +Defined in types/lib/index.d.ts:19
@@ -845,7 +1038,7 @@ Defined in types/lib/index.d.ts:8 • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -853,7 +1046,7 @@ Defined in types/lib/index.d.ts:8 ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -877,7 +1070,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -911,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/23602ec6b/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:** @@ -935,7 +1128,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L324)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L330)* ___ @@ -943,7 +1136,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L325)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L331)* ___ @@ -951,7 +1144,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L323)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L329)* ___ @@ -959,7 +1152,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L322)* +*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L328)*
@@ -972,7 +1165,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L336)* ___ @@ -980,7 +1173,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L335)*
@@ -993,7 +1186,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L337)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L343)* ___ @@ -1001,7 +1194,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L341)* ___ @@ -1009,7 +1202,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L342)* ___ @@ -1017,7 +1210,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L334)* +*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L340)*
@@ -1060,6 +1253,8 @@ ___ + + @@ -1076,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/23602ec6b/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:** @@ -1092,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/23602ec6b/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:** @@ -1118,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/23602ec6b/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:** @@ -1144,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/23602ec6b/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:** @@ -1157,236 +1352,73 @@ Name | Type |
-# Class: AssetBuyer +# Interface: ZeroExProvider + +The interface for the provider used internally by 0x libraries +Any property we use from any SupportedProvider should we explicitly +add here -## Constructors +## Properties +### `Optional` isMetaMask +• **isMetaMask**? : *undefined | false | true* -\+ **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/23602ec6b/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/23602ec6b/packages/asset-buyer/src/asset_buyer.ts#L40)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L31)* ___ -### networkId +### `Optional` isParity -• **networkId**: *number* +• **isParity**? : *undefined | false | true* -*Defined in [asset-buyer/src/asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-buyer/src/asset_buyer.ts#L38)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L32)* ___ -### orderProvider +### `Optional` isZeroExProvider -• **orderProvider**: *[OrderProvider](#interface-orderprovider)* +• **isZeroExProvider**? : *undefined | false | true* -*Defined in [asset-buyer/src/asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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/23602ec6b/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/23602ec6b/packages/asset-buyer/src/asset_buyer.ts#L36)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L30)* ## Methods -### executeBuyQuoteAsync +### `Optional` enable -▸ **executeBuyQuoteAsync**(`buyQuote`: [BuyQuote](#interface-buyquote), `options`: `Partial`): *`Promise`* +▸ **enable**(): *`Promise`* -*Defined in [asset-buyer/src/asset_buyer.ts:226](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-buyer/src/asset_buyer.ts#L226)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L34)* -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. +**Returns:** *`Promise`* ___ -### getAvailableAssetDatasAsync +### sendAsync -▸ **getAvailableAssetDatasAsync**(): *`Promise`* +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [asset-buyer/src/asset_buyer.ts:302](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-buyer/src/asset_buyer.ts#L302)* - -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/23602ec6b/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. +*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 | 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. | +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | -**Returns:** *`Promise`* - -An object that conforms to BuyQuote that satisfies the request. See type definition for more information. +**Returns:** *void* ___ -### getBuyQuoteForERC20TokenAddressAsync +### `Optional` stop -▸ **getBuyQuoteForERC20TokenAddressAsync**(`tokenAddress`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* +▸ **stop**(): *void* -*Defined in [asset-buyer/src/asset_buyer.ts:173](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-buyer/src/asset_buyer.ts#L173)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L33)* -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/23602ec6b/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:311](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-buyer/src/asset_buyer.ts#L311)* - -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/23602ec6b/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/23602ec6b/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 +**Returns:** *void*
@@ -1436,6 +1468,10 @@ An instance of AssetBuyer + + + + @@ -1479,6 +1515,10 @@ An instance of AssetBuyer + + + + @@ -1489,13 +1529,23 @@ An instance of AssetBuyer ## Properties +### chainId + +• **chainId**: *number* + +*Inherited from [Order](#interface-order).[chainId](#chainid)* + +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* + +___ + ### exchangeAddress • **exchangeAddress**: *string* *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -1505,7 +1555,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -1515,7 +1565,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -1525,7 +1575,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L11)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -1535,7 +1585,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -1545,7 +1595,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -1555,7 +1605,17 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L13)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* + +___ + +### makerFeeAssetData + +• **makerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* + +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -1565,7 +1625,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -1575,7 +1635,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L10)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -1583,7 +1643,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L41)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -1593,7 +1653,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L12)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -1603,7 +1663,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -1613,7 +1673,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -1623,7 +1683,17 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* + +___ + +### takerFeeAssetData + +• **takerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* + +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -1655,31 +1725,6 @@ ___ - - - - - - - - - - - - - - - - - - - - - -## Type aliases - - - @@ -1723,7 +1768,7 @@ ___ Ƭ **LiquidityRequestOpts**: *`Pick`* -*Defined in [asset-buyer/src/types.ts:83](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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)*
@@ -1742,11 +1787,13 @@ ___ + + ### EIP1193Event Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L70)* +*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 @@ -1763,7 +1810,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L3)* +*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: @@ -1792,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/23602ec6b/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. @@ -1807,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/23602ec6b/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 2a48478030..96f2a7801f 100644 --- a/packages/asset-swapper/CHANGELOG.json +++ b/packages/asset-swapper/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "version": "2.0.0", diff --git a/packages/asset-swapper/CHANGELOG.md b/packages/asset-swapper/CHANGELOG.md index 77d3e67031..6104cb491c 100644 --- a/packages/asset-swapper/CHANGELOG.md +++ b/packages/asset-swapper/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.1.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v2.0.0 - _September 17, 2019_ * AssetSwapper to use `@0x/orderbook` to fetch and subscribe to order updates (#2056) diff --git a/packages/asset-swapper/docs/reference.mdx b/packages/asset-swapper/docs/reference.mdx index 83b6566a60..7ebf9fa69b 100644 --- a/packages/asset-swapper/docs/reference.mdx +++ b/packages/asset-swapper/docs/reference.mdx @@ -1,2433 +1,3 @@ - - -# 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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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:125](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L125)* - -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:29](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L29)* - -___ - -### orderbook - -• **orderbook**: *`Orderbook`* - -*Defined in [asset-swapper/src/swap_quoter.ts:28](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L28)* - -___ - -### provider - -• **provider**: *`ZeroExProvider`* - -*Defined in [asset-swapper/src/swap_quoter.ts:27](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L27)* - -## Methods - -### destroyAsync - -▸ **destroyAsync**(): *`Promise`* - -*Defined in [asset-swapper/src/swap_quoter.ts:390](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L390)* - -Destroys any subscriptions or connections. - -**Returns:** *`Promise`* - -___ - -### getAvailableMakerAssetDatasAsync - -▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* - -*Defined in [asset-swapper/src/swap_quoter.ts:308](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L308)* - -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:293](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L293)* - -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:267](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L267)* - -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:209](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L209)* - -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:184](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L184)* - -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:239](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L239)* - -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:158](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L158)* - -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:340](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L340)* - -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:371](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L371)* - -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:323](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L323)* - -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:112](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L112)* - -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:40](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L40)* - -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:60](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L60)* - -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:87](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L87)* - -Instantiates a new SwapQuoter instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint -and a websocket endpoint. This is more effecient than `getSwapQuoterForStandardRelayerAPIUrl` when requesting multiple quotes. - -**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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/packages/asset-swapper/src/types.ts#L305)* - -___ - -### InsufficientAssetLiquidity - -• **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" - -*Defined in [asset-swapper/src/types.ts:302](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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:321](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L321)* - -___ - -### takerTokensAvailableInBaseUnits - -• **takerTokensAvailableInBaseUnits**: *`BigNumber`* - -*Defined in [asset-swapper/src/types.ts:322](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L322)* - -
- -# 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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/packages/asset-swapper/src/types.ts#L280)* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -# Interface: DataItem - - -## Properties - -### `Optional` components - -• **components**? : *[DataItem](#class-dataitem)[]* - -*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L131)* - -___ - -### name - -• **name**: *string* - -*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L129)* - -___ - -### type - -• **type**: *string* - -*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L130)* - -
- - - - - - - -# Interface: EIP1193Provider - - -## Properties - -### isEIP1193 - -• **isEIP1193**: *boolean* - -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/packages/ethereum-types/src/index.ts#L14)* - -**Parameters:** - -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | - -**Returns:** *void* - -
- - - -# Interface: JSONRPCRequestPayload - - -## Properties - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L324)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L325)* - -___ - -### method - -• **method**: *string* - -*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L323)* - -___ - -### params - -• **params**: *any[]* - -*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L322)* - -
- -# Interface: JSONRPCResponseError - - -## Properties - -### code - -• **code**: *number* - -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L330)* - -___ - -### message - -• **message**: *string* - -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L329)* - -
- -# Interface: JSONRPCResponsePayload - - -## Properties - -### `Optional` error - -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* - -*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L337)* - -___ - -### id - -• **id**: *number* - -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L335)* - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L336)* - -___ - -### result - -• **result**: *any* - -*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L334)* - -
- - - - - - - -# Interface: MethodAbi - - -## Properties - -### constant - -• **constant**: *boolean* - -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/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/11d3d6804/packages/ethereum-types/src/index.ts#L90)* - -
- - - - - - - - - - - - - - - - - - - - - - - - - # Class: InsufficientAssetLiquidityError Error class representing insufficient asset liquidity @@ -2439,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/11d3d6804/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:** @@ -2455,7 +25,7 @@ Name | Type | Description | • **amountAvailableToFill**: *`BigNumber`* -*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -2500,6 +70,2446 @@ ___
+ +# 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)* + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2514,7 +2524,7 @@ ___ *Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L141)* ___ @@ -2524,7 +2534,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L129)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2534,7 +2544,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L130)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L136)*
@@ -2555,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/11d3d6804/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:** @@ -2571,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/11d3d6804/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:** @@ -2597,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/11d3d6804/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:** @@ -2623,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/11d3d6804/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:** @@ -2649,7 +2659,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -2657,7 +2667,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -2665,7 +2675,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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 @@ -2673,7 +2683,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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`* @@ -2683,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/11d3d6804/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:** @@ -2700,7 +2710,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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* @@ -2715,7 +2725,7 @@ ___ • **accepted**: *`SignedOrder`[]* -*Defined in [orderbook/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -2723,7 +2733,7 @@ ___ • **rejected**: *[RejectedOrder](#class-rejectedorder)[]* -*Defined in [orderbook/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)*
@@ -2736,7 +2746,7 @@ ___ • **added**: *`APIOrder`[]* -*Defined in [orderbook/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -2744,7 +2754,7 @@ ___ • **assetPairKey**: *string* -*Defined in [orderbook/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -2752,7 +2762,7 @@ ___ • **removed**: *`APIOrder`[]* -*Defined in [orderbook/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)*
@@ -2767,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/11d3d6804/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)* ___ @@ -2775,7 +2785,7 @@ ___ • **wsOpts**? : *`WSOpts`* -*Defined in [orderbook/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)*
@@ -2788,7 +2798,7 @@ ___ • **message**: *string* -*Defined in [orderbook/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -2796,7 +2806,7 @@ ___ • **order**: *`SignedOrder`* -*Defined in [orderbook/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)*
@@ -2811,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/11d3d6804/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)* ___ @@ -2819,7 +2829,7 @@ ___ • **networkId**? : *undefined | number* -*Defined in [orderbook/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -2827,7 +2837,7 @@ ___ • **perPage**? : *undefined | number* -*Defined in [orderbook/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -2835,7 +2845,7 @@ ___ • **pollingIntervalMs**: *number* -*Defined in [orderbook/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)*
@@ -2850,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/11d3d6804/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)* ___ @@ -2858,7 +2868,7 @@ ___ • **networkId**? : *undefined | number* -*Defined in [orderbook/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -2866,7 +2876,7 @@ ___ • **websocketEndpoint**: *string* -*Defined in [orderbook/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)*
@@ -2879,7 +2889,7 @@ ___ • **metaData**: *object* -*Defined in [types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L403)* +*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L408)* ___ @@ -2887,7 +2897,7 @@ ___ • **order**: *[SignedOrder](#class-signedorder)* -*Defined in [types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L402)* +*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L407)*
@@ -2902,7 +2912,7 @@ ___ • **assetData**: *string* -*Defined in [types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L419)* +*Defined in [types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L424)* ___ @@ -2910,7 +2920,7 @@ ___ • **maxAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L421)* +*Defined in [types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L426)* ___ @@ -2918,7 +2928,7 @@ ___ • **minAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:420](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L420)* +*Defined in [types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L425)* ___ @@ -2926,7 +2936,7 @@ ___ • **precision**: *number* -*Defined in [types/src/index.ts:422](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L422)* +*Defined in [types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L427)*
@@ -2939,7 +2949,7 @@ ___ • **assetDataA**: *[Asset](#class-asset)* -*Defined in [types/src/index.ts:414](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L414)* +*Defined in [types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L419)* ___ @@ -2947,7 +2957,7 @@ ___ • **assetDataB**: *[Asset](#class-asset)* -*Defined in [types/src/index.ts:415](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L415)* +*Defined in [types/src/index.ts:420](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L420)*
@@ -2989,6 +2999,10 @@ ___ + + + + @@ -3032,6 +3046,10 @@ ___ + + + + @@ -3042,13 +3060,23 @@ ___ ## Properties +### chainId + +• **chainId**: *number* + +*Inherited from [Order](#interface-order).[chainId](#chainid)* + +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* + +___ + ### exchangeAddress • **exchangeAddress**: *string* *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -3058,7 +3086,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -3068,7 +3096,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -3078,7 +3106,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L11)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -3088,7 +3116,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -3098,7 +3126,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -3108,7 +3136,17 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L13)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* + +___ + +### makerFeeAssetData + +• **makerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* + +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -3118,7 +3156,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -3128,7 +3166,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L10)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -3136,7 +3174,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L41)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -3146,7 +3184,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L12)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -3156,7 +3194,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -3166,7 +3204,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -3176,7 +3214,17 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* + +___ + +### takerFeeAssetData + +• **takerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* + +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -3208,31 +3256,6 @@ ___ - - - - - - - - - - - - - - - - - - - - - -## Type aliases - - - @@ -3278,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/11d3d6804/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)* ___ @@ -3297,7 +3320,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -3305,11 +3328,13 @@ ___ + + ### EIP1193Event Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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 @@ -3326,7 +3351,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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: @@ -3353,7 +3378,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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)* ___ @@ -3361,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/11d3d6804/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. @@ -3376,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/11d3d6804/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)*
@@ -3389,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/11d3d6804/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)*
@@ -3412,3 +3437,34 @@ ___ + + + +## Type aliases + + + + + + + + + + + + + + + + + + + + + + + + + +
+ diff --git a/packages/base-contract/CHANGELOG.json b/packages/base-contract/CHANGELOG.json index b186f4a508..1e11866ef6 100644 --- a/packages/base-contract/CHANGELOG.json +++ b/packages/base-contract/CHANGELOG.json @@ -22,7 +22,8 @@ "note": "Properly encode `BigNumber` indexed filter values in `getTopicsForIndexedArgs()`", "pr": 2155 } - ] + ], + "timestamp": 1570135330 }, { "version": "5.4.0", diff --git a/packages/base-contract/CHANGELOG.md b/packages/base-contract/CHANGELOG.md index 985b8e9aa6..4fcff1d41b 100644 --- a/packages/base-contract/CHANGELOG.md +++ b/packages/base-contract/CHANGELOG.md @@ -5,6 +5,14 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v5.5.0-beta.0 - _October 3, 2019_ + + * Automatically decode and throw rich reverts in `_throwIfRevertWithReasonCallResult` (#1761) + * Remove dependency on ethers.js (#1761) + * Add more RevertError decoding functions (#1819) + * Make the Promise returned by `awaitTransactionSuccessAsync` compatible with base Promise type (#1885) + * Properly encode `BigNumber` indexed filter values in `getTopicsForIndexedArgs()` (#2155) + ## v5.4.0 - _September 17, 2019_ * Add `evmExecAsync` to use local EVM instead of eth_call for pure functions (#2108) diff --git a/packages/connect/CHANGELOG.json b/packages/connect/CHANGELOG.json index c653721f13..02b53e52f5 100644 --- a/packages/connect/CHANGELOG.json +++ b/packages/connect/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/packages/connect/CHANGELOG.md b/packages/connect/CHANGELOG.md index db85e5397a..2a656265d7 100644 --- a/packages/connect/CHANGELOG.md +++ b/packages/connect/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v5.1.0-beta.0 - _October 3, 2019_ + + * Dependencies updated + ## v5.0.19 - _September 17, 2019_ * Dependencies updated diff --git a/packages/connect/docs/reference.mdx b/packages/connect/docs/reference.mdx index 5361208041..5dba505116 100644 --- a/packages/connect/docs/reference.mdx +++ b/packages/connect/docs/reference.mdx @@ -1,204 +1,170 @@ +# 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)* - - - - - - - - - - - - - - - - - - - - - - -## Type aliases - - - - - -### AssetPairsResponse - -Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›* - -*Defined in [types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L411)* - -___ - - - - - -### FeeRecipientsResponse - -Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›* - -*Defined in [types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L475)* - -___ - - - - - -### OrdersResponse - -Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›* - -*Defined in [types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L399)* - -___ - - - -# Interface: Client - - -## Implemented by - -* [HttpClient](#class-httpclient) - - -## Properties - -### getAssetPairsAsync - -• **getAssetPairsAsync**: *function* - -*Defined in [connect/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/connect/src/types.ts#L18)* - -#### Type declaration: - -▸ (`requestOpts?`: `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise>`* +Instantiates a new HttpClient instance **Parameters:** -Name | Type | ------- | ------ | -`requestOpts?` | `AssetPairsRequestOpts` & `PagedRequestOpts` | +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`* + +The resulting AssetPairsResponse that match the request ___ ### getFeeRecipientsAsync -• **getFeeRecipientsAsync**: *function* +▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [connect/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/connect/src/types.ts#L25)* +*Defined in [connect/src/http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L160)* -#### Type declaration: - -▸ (`requestOpts?`: [PagedRequestOpts](#class-pagedrequestopts)): *`Promise`* +Retrieve the list of fee recipient addresses used by the relayer. **Parameters:** -Name | Type | ------- | ------ | -`requestOpts?` | [PagedRequestOpts](#class-pagedrequestopts) | +Name | Type | Description | +------ | ------ | ------ | +`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and network id. | + +**Returns:** *`Promise`* + +The resulting FeeRecipientsResponse ___ ### getOrderAsync -• **getOrderAsync**: *function* +▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise`* -*Defined in [connect/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/connect/src/types.ts#L22)* +*Defined in [connect/src/http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L99)* -#### Type declaration: - -▸ (`orderHash`: string): *`Promise`* +Retrieve a specific order from the API **Parameters:** -Name | Type | ------- | ------ | -`orderHash` | string | +Name | Type | Description | +------ | ------ | ------ | +`orderHash` | string | An orderHash generated from the desired order | +`requestOpts?` | [RequestOpts](#interface-requestopts) | - | + +**Returns:** *`Promise`* + +The APIOrder that matches the supplied orderHash ___ ### getOrderConfigAsync -• **getOrderConfigAsync**: *function* +▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise`* -*Defined in [connect/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/connect/src/types.ts#L24)* +*Defined in [connect/src/http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L139)* -#### Type declaration: - -▸ (`request`: `OrderConfigRequest`): *`Promise`* +Retrieve fee information from the API **Parameters:** -Name | Type | ------- | ------ | -`request` | `OrderConfigRequest` | +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**: *function* +▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [connect/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/connect/src/types.ts#L23)* +*Defined in [connect/src/http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L117)* -#### Type declaration: - -▸ (`request`: `OrderbookRequest`, `requestOpts?`: [PagedRequestOpts](#class-pagedrequestopts)): *`Promise`* +Retrieve an orderbook from the API **Parameters:** -Name | Type | ------- | ------ | -`request` | `OrderbookRequest` | -`requestOpts?` | [PagedRequestOpts](#class-pagedrequestopts) | +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**: *function* +▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [connect/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/connect/src/types.ts#L21)* +*Defined in [connect/src/http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L79)* -#### Type declaration: - -▸ (`requestOpts?`: `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise>`* +Retrieve orders from the API **Parameters:** -Name | Type | ------- | ------ | -`requestOpts?` | `OrdersRequestOpts` & `PagedRequestOpts` | +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**: *function* +▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise`* -*Defined in [connect/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/connect/src/types.ts#L26)* +*Defined in [connect/src/http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/connect/src/http_client.ts#L177)* -#### Type declaration: - -▸ (`signedOrder`: `SignedOrder`): *`Promise`* +Submit a signed order to the API **Parameters:** -Name | Type | ------- | ------ | -`signedOrder` | `SignedOrder` | +Name | Type | Description | +------ | ------ | ------ | +`signedOrder` | `SignedOrder` | A SignedOrder instance to submit | +`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying network id. | + +**Returns:** *`Promise`*
@@ -208,6 +174,32 @@ Name | Type | + + + + + + + + + + + + + + + + + + + + + + + + + + # Interface: APIOrder @@ -217,7 +209,7 @@ Name | Type | • **metaData**: *object* -*Defined in [types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L403)* +*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L408)* ___ @@ -225,7 +217,7 @@ ___ • **order**: *[SignedOrder](#class-signedorder)* -*Defined in [types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L402)* +*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L407)*
@@ -273,6 +265,10 @@ ___ + + + + @@ -281,181 +277,12 @@ ___ -# Class: HttpClient -This class includes all the functionality related to interacting with a set of HTTP endpoints -that implement the standard relayer API v2 -## Implements -* [Client](#interface-client) -## Constructors - - - -\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)* - -*Defined in [connect/src/http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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/23602ec6b/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`* - -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/23602ec6b/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. | - -**Returns:** *`Promise`* - -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/23602ec6b/packages/connect/src/http_client.ts#L99)* - -Retrieve a specific order from the API - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | An orderHash generated from the desired order | -`requestOpts?` | [RequestOpts](#interface-requestopts) | - | - -**Returns:** *`Promise`* - -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/23602ec6b/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/23602ec6b/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/23602ec6b/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/23602ec6b/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`* - -
- @@ -493,7 +320,7 @@ Name | Type | Description | • **page**? : *undefined | number* -*Defined in [types/src/index.ts:482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L482)* +*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L491)* ___ @@ -501,7 +328,7 @@ ___ • **perPage**? : *undefined | number* -*Defined in [types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L483)* +*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L492)*
@@ -518,7 +345,7 @@ ___ • **page**: *number* -*Defined in [types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L452)* +*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L459)* ___ @@ -526,7 +353,7 @@ ___ • **perPage**: *number* -*Defined in [types/src/index.ts:453](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L453)* +*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L460)* ___ @@ -534,7 +361,7 @@ ___ • **records**: *`T`[]* -*Defined in [types/src/index.ts:454](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L454)* +*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L461)* ___ @@ -542,7 +369,7 @@ ___ • **total**: *number* -*Defined in [types/src/index.ts:451](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L451)* +*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L458)*
@@ -559,7 +386,7 @@ ___ • **networkId**? : *undefined | number* -*Defined in [types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L478)* +*Defined in [types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L487)*
@@ -568,13 +395,23 @@ ___ ## Properties +### chainId + +• **chainId**: *number* + +*Inherited from [Order](#interface-order).[chainId](#chainid)* + +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* + +___ + ### exchangeAddress • **exchangeAddress**: *string* *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ @@ -584,7 +421,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* ___ @@ -594,7 +431,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* ___ @@ -604,7 +441,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L11)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* ___ @@ -614,7 +451,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* ___ @@ -624,7 +461,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* ___ @@ -634,7 +471,17 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L13)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* + +___ + +### makerFeeAssetData + +• **makerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* + +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* ___ @@ -644,7 +491,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* ___ @@ -654,7 +501,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L10)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* ___ @@ -662,7 +509,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L41)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* ___ @@ -672,7 +519,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L12)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* ___ @@ -682,7 +529,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* ___ @@ -692,7 +539,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* ___ @@ -702,7 +549,17 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* + +___ + +### takerFeeAssetData + +• **takerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* + +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
@@ -753,10 +610,6 @@ ___ - -
- -
@@ -769,13 +622,13 @@ ___ #### ▪ **ordersChannelFactory**: *object* -*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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/23602ec6b/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 @@ -792,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 0c54429737..6292a31230 100644 --- a/packages/contract-addresses/CHANGELOG.json +++ b/packages/contract-addresses/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Removed `getNetworkIdByExchangeAddressOrThrow`. It's not needed with V3 tooling.", "pr": 2170 } - ] + ], + "timestamp": 1570135330 }, { "version": "3.2.0", diff --git a/packages/contract-addresses/CHANGELOG.md b/packages/contract-addresses/CHANGELOG.md index 5e8c1a25b4..1237f7d52c 100644 --- a/packages/contract-addresses/CHANGELOG.md +++ b/packages/contract-addresses/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.3.0-beta.0 - _October 3, 2019_ + + * Removed `getNetworkIdByExchangeAddressOrThrow`. It's not needed with V3 tooling. (#2170) + ## v3.2.0 - _September 17, 2019_ * Added `getNetworkIdByExchangeAddressOrThrow` (#2096) diff --git a/packages/contract-artifacts/CHANGELOG.json b/packages/contract-artifacts/CHANGELOG.json index 8de3a2f8b9..3d4216c4ba 100644 --- a/packages/contract-artifacts/CHANGELOG.json +++ b/packages/contract-artifacts/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Add `deployedBytecode` field", "pr": 2181 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/packages/contract-artifacts/CHANGELOG.md b/packages/contract-artifacts/CHANGELOG.md index 760978e066..4805ebf53d 100644 --- a/packages/contract-artifacts/CHANGELOG.md +++ b/packages/contract-artifacts/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.3.0-beta.0 - _October 3, 2019_ + + * Use V3 contracts (#2181) + * Add `deployedBytecode` field (#2181) + ## v2.2.2 - _September 17, 2019_ * Dependencies updated diff --git a/packages/contract-wrappers/CHANGELOG.json b/packages/contract-wrappers/CHANGELOG.json index 41590bd13c..966692cae0 100644 --- a/packages/contract-wrappers/CHANGELOG.json +++ b/packages/contract-wrappers/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Update exchange wrapper", "pr": 1742 } - ] + ], + "timestamp": 1570135330 }, { "version": "12.1.0", diff --git a/packages/contract-wrappers/CHANGELOG.md b/packages/contract-wrappers/CHANGELOG.md index f41c3169a3..cd13f04bd6 100644 --- a/packages/contract-wrappers/CHANGELOG.md +++ b/packages/contract-wrappers/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v12.2.0-beta.0 - _October 3, 2019_ + + * Use new `Order` and `ZeroExTransaction` structures with `domain` field (#1742) + * Update exchange wrapper (#1742) + ## v12.1.0 - _September 17, 2019_ * Add `devUtils` to `ContractWrappers` class. (#2146) diff --git a/packages/contract-wrappers/docs/reference.mdx b/packages/contract-wrappers/docs/reference.mdx index 6e1a3d1a2e..3761684f44 100644 --- a/packages/contract-wrappers/docs/reference.mdx +++ b/packages/contract-wrappers/docs/reference.mdx @@ -1,5 +1,27539 @@ +# Class: CoordinatorContract +## Constructors + + + +\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorContract](#class-coordinatorcontract)* + +*Overrides void* + +*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:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | CoordinatorContract.deployedBytecode | + +**Returns:** *[CoordinatorContract](#class-coordinatorcontract)* + +## 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.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:1195](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1195)* + +**Returns:** *[ContractAbi](#contractabi)* + +The contract ABI + +___ + +### `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1148](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1148)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | + +**Returns:** *`Promise`* + +___ + +### `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1115](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1115)* + +**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 + +### EIP712_COORDINATOR_DOMAIN_HASH + +#### ▪ **EIP712_COORDINATOR_DOMAIN_HASH**: *object* + +*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: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 +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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: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: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 +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | [BlockParam](#blockparam) | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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: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. + +#### callAsync + +▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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 +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transaction` | object | - | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | - | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | - | Proof that the transaction has been signed by the signer. | +`approvalExpirationTimeSeconds` | `BigNumber`[] | - | Array of expiration times in seconds for which each corresponding approval signature expires. | +`approvalSignatures` | string[] | - | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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: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. + +#### callAsync + +▸ **callAsync**(`data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* + +*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 +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`data` | string | - | Exchange calldata representing a fill method. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise>`* + +The orders from the Exchange calldata. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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: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`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*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 | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | Proof that the transaction has been signed by the signer. | +`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +#### callAsync + +▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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 +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transaction` | object | - | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | - | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | - | Proof that the transaction has been signed by the signer. | +`approvalExpirationTimeSeconds` | `BigNumber`[] | - | Array of expiration times in seconds for which each corresponding approval signature expires. | +`approvalSignatures` | string[] | - | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### estimateGasAsync + +▸ **estimateGasAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | Proof that the transaction has been signed by the signer. | +`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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: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 +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | Proof that the transaction has been signed by the signer. | +`approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | + +**Returns:** *string* + +The ABI encoded transaction data as a string + +#### sendTransactionAsync + +▸ **sendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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 | 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: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. + +#### callAsync + +▸ **callAsync**(`approval`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*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 +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`approval` | object | - | Coordinator approval message containing the transaction hash, transaction signature, and expiration of the approval. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +EIP712 hash of the Coordinator approval message with the domain separator of this contract. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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: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. + +#### callAsync + +▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*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 +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`hash` | string | - | Any 32 byte hash. | +`signature` | string | - | Proof that the hash has been signed by signer. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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: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. + +#### callAsync + +▸ **callAsync**(`transaction`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*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 +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transaction` | object | - | 0x transaction containing salt, signerAddress, and data. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | [BlockParam](#blockparam) | - | - | + +**Returns:** *`Promise`* + +EIP712 hash of the transaction with the domain separator of this contract. + +#### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts: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 @@ -10,9 +27544,9 @@ the 0x V2 Coordinator extension contract. -\+ **new CoordinatorWrapper**(`provider`: `SupportedProvider`, `networkId`: number, `address?`: undefined | string, `exchangeAddress?`: undefined | string, `registryAddress?`: undefined | string): *[CoordinatorWrapper](#class-coordinatorwrapper)* +\+ **new CoordinatorWrapper**(`provider`: [SupportedProvider](#supportedprovider), `networkId`: number, `address?`: undefined | string, `exchangeAddress?`: undefined | string, `registryAddress?`: undefined | string): *[CoordinatorWrapper](#class-coordinatorwrapper)* -*Defined in [coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L43)* +*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 @@ -20,7 +27554,7 @@ Instantiate CoordinatorWrapper Name | Type | Description | ------ | ------ | ------ | -`provider` | `SupportedProvider` | - | +`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. | @@ -32,9 +27566,9 @@ Name | Type | Description | ### abi -• **abi**: *`ContractAbi`* = Coordinator.compilerOutput.abi +• **abi**: *[ContractAbi](#contractabi)* = Coordinator.compilerOutput.abi -*Defined in [coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L34)* +*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)* ___ @@ -42,7 +27576,7 @@ ___ • **address**: *string* -*Defined in [coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L36)* +*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)* ___ @@ -50,7 +27584,7 @@ ___ • **exchangeAddress**: *string* -*Defined in [coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L37)* +*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)* ___ @@ -58,7 +27592,7 @@ ___ • **networkId**: *number* -*Defined in [coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L35)* +*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)* ___ @@ -66,7 +27600,7 @@ ___ • **registryAddress**: *string* -*Defined in [coordinator_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L38)* +*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 @@ -74,7 +27608,7 @@ ___ ▸ **assertValidCoordinatorApprovalsOrThrowAsync**(`transaction`: `ZeroExTransaction`, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *`Promise`* -*Defined in [coordinator_wrapper.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L637)* +*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. @@ -97,7 +27631,7 @@ ___ ▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L273)* +*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. @@ -120,7 +27654,7 @@ ___ ▸ **batchFillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:203](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L203)* +*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 @@ -148,7 +27682,7 @@ ___ ▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:238](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L238)* +*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 @@ -171,7 +27705,7 @@ ___ ▸ **batchHardCancelOrdersAsync**(`orders`: `SignedOrder`[], `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L568)* +*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. @@ -193,7 +27727,7 @@ ___ ▸ **batchSoftCancelOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* -*Defined in [coordinator_wrapper.ts:482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L482)* +*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 @@ -213,7 +27747,7 @@ ___ ▸ **fillOrKillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:166](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L166)* +*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. @@ -237,7 +27771,7 @@ ___ ▸ **fillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:101](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L101)* +*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 @@ -260,34 +27794,11 @@ Transaction hash. ___ -### fillOrderNoThrowAsync - -▸ **fillOrderNoThrowAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [coordinator_wrapper.ts:133](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L133)* - -No-throw version of fillOrderAsync. This version will not throw if the fill fails. This allows the caller to save gas at the expense of not knowing the reason the fill failed. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | -`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - ### getSignerAddressAsync ▸ **getSignerAddressAsync**(`hash`: string, `signature`: string): *`Promise`* -*Defined in [coordinator_wrapper.ts:669](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L669)* +*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. @@ -308,7 +27819,7 @@ ___ ▸ **hardCancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:536](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L536)* +*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. @@ -329,7 +27840,7 @@ ___ ▸ **hardCancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:603](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L603)* +*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 @@ -349,39 +27860,11 @@ Transaction hash. ___ -### marketBuyOrdersAsync - -▸ **marketBuyOrdersAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [coordinator_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L313)* - -Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. -Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints -registered in the coordinator registry contract. It requests a signature from each coordinator server before -submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the -signatures and then fills the order through the Exchange contract. -If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`makerAssetFillAmount` | `BigNumber` | - | Maker asset fill amount. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - ### marketBuyOrdersNoThrowAsync ▸ **marketBuyOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:384](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L384)* +*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 @@ -400,39 +27883,11 @@ Transaction hash. ___ -### marketSellOrdersAsync - -▸ **marketSellOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [coordinator_wrapper.ts:351](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L351)* - -Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. -Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints -registered in the coordinator registry contract. It requests a signature from each coordinator server before -submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the -signatures and then fills the order through the Exchange contract. -If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | -`takerAssetFillAmount` | `BigNumber` | - | Taker asset fill amount. | -`takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - ### marketSellOrdersNoThrowAsync ▸ **marketSellOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L417)* +*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 @@ -455,7 +27910,7 @@ ___ ▸ **softCancelOrderAsync**(`order`: `Order` | `SignedOrder`): *`Promise`* -*Defined in [coordinator_wrapper.ts:447](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L447)* +*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. @@ -473,328 +27928,406 @@ CoordinatorServerCancellationResponse. See [Cancellation Response](https://githu
-# Class: IWalletContract +# 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 IWalletContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[IWalletContract](#class-iwalletcontract)* +\+ **new AbiDecoder**(`abiArrays`: [AbiDefinition](#abidefinition)[][]): *[AbiDecoder](#class-abidecoder)* -*Overrides void* +*Defined in [utils/src/abi_decoder.ts:42](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/utils/src/abi_decoder.ts#L42)* -*Defined in [generated-wrappers/i_wallet.ts:206](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L206)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[IWalletContract](#class-iwalletcontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - - - - - -___ - -### address - -• **address**: *string* - - - - - -___ - -Args - -• **constructorArgs**: *any[]* - - - - - -___ - -### contractName - -• **contractName**: *string* - - - - - -## Methods - -### evmExecAsync - -▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* - - - - - -**Parameters:** - -Name | Type | ------- | ------ | -`input` | `Buffer` | - -**Returns:** *`Promise`* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/i_wallet.ts:179](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L179)* - -**Returns:** *`ContractAbi`* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [generated-wrappers/i_wallet.ts:137](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L137)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | `ContractAbi` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* - -*Defined in [generated-wrappers/i_wallet.ts:112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L112)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - - - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### isValidSignature - -#### ▪ **isValidSignature**: *object* - -*Defined in [generated-wrappers/i_wallet.ts:33](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L33)* - -Verifies that a signature is valid. - -#### callAsync - -▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/i_wallet.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L42)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Message hash that is signed. | -`signature` | string | - | Proof of signing. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | `BlockParam` | - | - | - -**Returns:** *`Promise`* - -Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256("isValidWalletSignature(bytes32,address,bytes)")) - -#### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/i_wallet.ts:104](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L104)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -#### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/i_wallet.ts:97](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L97)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* - -*Defined in [generated-wrappers/i_wallet.ts:87](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L87)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). +Instantiate an AbiDecoder **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`hash` | string | Message hash that is signed. | -`signature` | string | Proof of signing. | +`abiArrays` | [AbiDefinition](#abidefinition)[][] | An array of contract ABI's | -**Returns:** *string* +**Returns:** *[AbiDecoder](#class-abidecoder)* -
+AbiDecoder instance -# Class: CoordinatorServerError +## Methods +### addABI -## Constructors +▸ **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)* - -\+ **new CoordinatorServerError**(`message`: [CoordinatorServerErrorMsg](#enumeration-coordinatorservererrormsg), `approvedOrders`: `SignedOrder`[], `cancellations`: [CoordinatorServerCancellationResponse](#interface-coordinatorservercancellationresponse)[], `errors`: [CoordinatorServerResponse](#interface-coordinatorserverresponse)[]): *[CoordinatorServerError](#class-coordinatorservererror)* - -*Defined in [utils/coordinator_server_types.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L43)* +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 | ------- | ------ | -`message` | [CoordinatorServerErrorMsg](#enumeration-coordinatorservererrormsg) | -`approvedOrders` | `SignedOrder`[] | -`cancellations` | [CoordinatorServerCancellationResponse](#interface-coordinatorservercancellationresponse)[] | -`errors` | [CoordinatorServerResponse](#interface-coordinatorserverresponse)[] | +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:** *[CoordinatorServerError](#class-coordinatorservererror)* - -## Properties - -#### `Optional` approvedOrders - -• **approvedOrders**? : *`SignedOrder`[]* = [] - -*Defined in [utils/coordinator_server_types.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L41)* +**Returns:** *void* ___ -### `Optional` cancellations +### decodeCalldataOrThrow -• **cancellations**? : *[CoordinatorServerCancellationResponse](#interface-coordinatorservercancellationresponse)[]* = [] +▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* -*Defined in [utils/coordinator_server_types.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L42)* +*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. ___ -### errors +### tryToDecodeLogOrNoop -• **errors**: *[CoordinatorServerResponse](#interface-coordinatorserverresponse)[]* +▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* -*Defined in [utils/coordinator_server_types.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L43)* +*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. -### message +**Type parameters:** -• **message**: *[CoordinatorServerErrorMsg](#enumeration-coordinatorservererrormsg)* +▪ **ArgsType**: *`DecodedLogArgs`* -*Overrides void* +**Parameters:** -*Defined in [utils/coordinator_server_types.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L40)* - -___ - -### name - -• **name**: *string* - - - - - -___ - -### `Optional` stack - -• **stack**? : *undefined | string* - - - -*Overrides void* - - - -___ - -### `Static` Error - -▪ **Error**: *`ErrorConstructor`* +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 @@ -804,7 +28337,7 @@ ___ • **ContractNotDeployedOnNetwork**: = "CONTRACT_NOT_DEPLOYED_ON_NETWORK" -*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L32)* +*Defined in [contract-wrappers/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L16)* ___ @@ -812,7 +28345,7 @@ ___ • **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" -*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L42)* +*Defined in [contract-wrappers/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L26)* ___ @@ -820,7 +28353,7 @@ ___ • **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND" -*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L41)* +*Defined in [contract-wrappers/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L25)* ___ @@ -828,7 +28361,7 @@ ___ • **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER" -*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L33)* +*Defined in [contract-wrappers/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L17)* ___ @@ -836,7 +28369,7 @@ ___ • **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER" -*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L34)* +*Defined in [contract-wrappers/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L18)* ___ @@ -844,7 +28377,7 @@ ___ • **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT" -*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L35)* +*Defined in [contract-wrappers/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L19)* ___ @@ -852,7 +28385,7 @@ ___ • **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL" -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L36)* +*Defined in [contract-wrappers/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L20)* ___ @@ -860,7 +28393,7 @@ ___ • **InvalidJump**: = "INVALID_JUMP" -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L37)* +*Defined in [contract-wrappers/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L21)* ___ @@ -868,7 +28401,7 @@ ___ • **OutOfGas**: = "OUT_OF_GAS" -*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L38)* +*Defined in [contract-wrappers/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L22)* ___ @@ -876,7 +28409,7 @@ ___ • **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" -*Defined in [types.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L43)* +*Defined in [contract-wrappers/src/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L27)* ___ @@ -884,7 +28417,7 @@ ___ • **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" -*Defined in [types.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L40)* +*Defined in [contract-wrappers/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L24)* ___ @@ -892,7 +28425,7 @@ ___ • **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" -*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L39)* +*Defined in [contract-wrappers/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L23)*
@@ -905,219 +28438,1340 @@ ___ • **CompleteFillFailed**: = "COMPLETE_FILL_FAILED" -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L28)* +*Defined in [contract-wrappers/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L12)*
-# Enumeration: OrderStatus + + + + +# Enumeration: BlockParamLiteral ## Enumeration members -### Cancelled +### Earliest -• **Cancelled**: +• **Earliest**: = "earliest" -*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L91)* +*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L478)* ___ -### Expired +### Latest -• **Expired**: +• **Latest**: = "latest" -*Defined in [types.ts:89](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L89)* +*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L479)* ___ -### Fillable +### Pending -• **Fillable**: +• **Pending**: = "pending" -*Defined in [types.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L88)* - -___ - -### FullyFilled - -• **FullyFilled**: - -*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L90)* - -___ - -### Invalid - -• **Invalid**: = 0 - -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L85)* - -___ - -### InvalidMakerAssetAmount - -• **InvalidMakerAssetAmount**: - -*Defined in [types.ts:86](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L86)* - -___ - -### InvalidTakerAssetAmount - -• **InvalidTakerAssetAmount**: - -*Defined in [types.ts:87](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L87)* - -
- -# Enumeration: CoordinatorServerErrorMsg - - -## Enumeration members - -### CancellationFailed - -• **CancellationFailed**: = "Failed to cancel with some coordinator server(s). See errors for more info. See cancellations for successful cancellations." - -*Defined in [utils/coordinator_server_types.ts:59](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L59)* - -___ - -### FillFailed - -• **FillFailed**: = "Failed to obtain approval signatures from some coordinator server(s). See errors for more info. Current transaction has been abandoned but you may resubmit with only approvedOrders (a new ZeroEx transaction will have to be signed)." - -*Defined in [utils/coordinator_server_types.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L60)* - -
- -# Enumeration: ContractError - - -## Enumeration members - -### ContractNotDeployedOnNetwork - -• **ContractNotDeployedOnNetwork**: = "CONTRACT_NOT_DEPLOYED_ON_NETWORK" - -*Defined in [utils/decorators.ts:4](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L4)* - -___ - -### ERC721NoApproval - -• **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" - -*Defined in [utils/decorators.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L14)* - -___ - -### ERC721OwnerNotFound - -• **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND" - -*Defined in [utils/decorators.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L13)* - -___ - -### InsufficientAllowanceForTransfer - -• **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER" - -*Defined in [utils/decorators.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L5)* - -___ - -### InsufficientBalanceForTransfer - -• **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER" - -*Defined in [utils/decorators.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L6)* - -___ - -### InsufficientEthBalanceForDeposit - -• **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT" - -*Defined in [utils/decorators.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L7)* - -___ - -### InsufficientWEthBalanceForWithdrawal - -• **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL" - -*Defined in [utils/decorators.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L8)* - -___ - -### InvalidJump - -• **InvalidJump**: = "INVALID_JUMP" - -*Defined in [utils/decorators.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L9)* - -___ - -### OutOfGas - -• **OutOfGas**: = "OUT_OF_GAS" - -*Defined in [utils/decorators.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L10)* - -___ - -### SignatureRequestDenied - -• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" - -*Defined in [utils/decorators.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L15)* - -___ - -### SubscriptionAlreadyPresent - -• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" - -*Defined in [utils/decorators.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L12)* - -___ - -### SubscriptionNotFound - -• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" - -*Defined in [utils/decorators.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L11)* +*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L480)*
-## Functions -### getAbiEncodedTransactionData -▸ **getAbiEncodedTransactionData**<**K**>(`contractInstance`: `ExchangeContract`, `methodName`: `K`, ...`params`: any[]): *string* -*Defined in [utils/getAbiEncodedTransactionData.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/getAbiEncodedTransactionData.ts#L8)* -Returns the ABI encoded transaction hash for a given method and arguments -**Type parameters:** -▪ **K**: *keyof ExchangeContract* -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`contractInstance` | `ExchangeContract` | - | -`methodName` | `K` | Must be a valid name of a function in the Solidity Exchange Contract | -`...params` | any[] | The appropriate arguments for the method given, in order | -**Returns:** *string* + + + + + + + + + + + + + + + + +# 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)*
@@ -1135,15 +29789,15 @@ blockPollingIntervalMs: The interval to use for block polling in event watching • **blockPollingIntervalMs**? : *undefined | number* -*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L56)* +*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`* +• **contractAddresses**? : *[ContractAddresses](#class-contractaddresses)* -*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L55)* +*Defined in [contract-wrappers/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L39)* ___ @@ -1151,7 +29805,7 @@ ___ • **gasPrice**? : *`BigNumber`* -*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L54)* +*Defined in [contract-wrappers/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/contract-wrappers/src/types.ts#L38)* ___ @@ -1159,11 +29813,1830 @@ ___ • **networkId**: *number* -*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L53)* +*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 + + +## 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: DecodedLogEvent <**ArgsType**> @@ -1178,7 +31651,7 @@ ___ • **isRemoved**: *boolean* -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L7)* +*Defined in [types/src/index.ts:853](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L853)* ___ @@ -1186,108 +31659,492 @@ ___ • **log**: *`LogWithDecodedArgs`* -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L8)* +*Defined in [types/src/index.ts:854](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L854)*
+ + + + + + + + + +# Interface: EIP712DomainWithDefaultSchema + + +## Properties + +### chainId + +• **chainId**: *number* + +*Defined in [types/src/index.ts:802](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L802)* + +___ + +### `Optional` name + +• **name**? : *undefined | string* + +*Defined in [types/src/index.ts:800](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L800)* + +___ + +### verifyingContract + +• **verifyingContract**: *string* + +*Defined in [types/src/index.ts:803](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L803)* + +___ + +### `Optional` version + +• **version**? : *undefined | string* + +*Defined in [types/src/index.ts:801](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L801)* + +
+ + + + + + + + + + + + + + + + + + + + + + + + # Interface: IndexedFilterValues ## Hierarchy -* **OrderAndTraderInfo** +* **IndexSignature** ## Properties -### orderInfo +### keyName -• **orderInfo**: *[OrderInfo](#interface-orderinfo)* +• **keyName**: *string* -*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L106)* +*Defined in [types/src/index.ts:679](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L679)* ___ -### traderInfo +### keyType -• **traderInfo**: *[TraderInfo](#interface-traderinfo)* +• **keyType**: *[Type](#class-type)* -*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L107)* +*Defined in [types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L680)* + +___ + +### valueName + +• **valueName**: *string* + +*Defined in [types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L681)*
-# Interface: OrderInfo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Interface: SignedOrder ## Properties -### orderHash +### chainId -• **orderHash**: *string* +• **chainId**: *number* -*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L80)* +*Inherited from [Order](#interface-order).[chainId](#chainid)* + +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L14)* ___ -### orderStatus +### exchangeAddress -• **orderStatus**: *[OrderStatus](#enumeration-orderstatus)* +• **exchangeAddress**: *string* -*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L79)* +*Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* + +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L15)* ___ -### orderTakerAssetFilledAmount +### expirationTimeSeconds -• **orderTakerAssetFilledAmount**: *`BigNumber`* +• **expirationTimeSeconds**: *`BigNumber`* -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L81)* +*Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* + +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L24)* + +___ + +### feeRecipientAddress + +• **feeRecipientAddress**: *string* + +*Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* + +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L18)* + +___ + +### makerAddress + +• **makerAddress**: *string* + +*Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* + +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L16)* + +___ + +### makerAssetAmount + +• **makerAssetAmount**: *`BigNumber`* + +*Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* + +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L20)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* + +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L26)* + +___ + +### makerFee + +• **makerFee**: *`BigNumber`* + +*Inherited from [Order](#interface-order).[makerFee](#makerfee)* + +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L22)* + +___ + +### makerFeeAssetData + +• **makerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* + +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L28)* + +___ + +### salt + +• **salt**: *`BigNumber`* + +*Inherited from [Order](#interface-order).[salt](#salt)* + +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L25)* + +___ + +### senderAddress + +• **senderAddress**: *string* + +*Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* + +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L19)* + +___ + +### signature + +• **signature**: *string* + +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L33)* + +___ + +### takerAddress + +• **takerAddress**: *string* + +*Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* + +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L17)* + +___ + +### takerAssetAmount + +• **takerAssetAmount**: *`BigNumber`* + +*Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* + +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L21)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* + +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L27)* + +___ + +### takerFee + +• **takerFee**: *`BigNumber`* + +*Inherited from [Order](#interface-order).[takerFee](#takerfee)* + +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L23)* + +___ + +### takerFeeAssetData + +• **takerFeeAssetData**: *string* + +*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* + +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L29)*
-# 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. +# Interface: SignedZeroExTransaction ## Properties -### `Optional` gasLimit +### data -• **gasLimit**? : *undefined | number* +• **data**: *string* -*Inherited from [TransactionOpts](#interface-transactionopts).[gasLimit](#optional-gaslimit)* +*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)* -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L66)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* ___ -### `Optional` gasPrice +### domain -• **gasPrice**? : *`BigNumber`* +• **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* -*Inherited from [TransactionOpts](#interface-transactionopts).[gasPrice](#optional-gasprice)* +*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[domain](#domain)* -*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L65)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* ___ -### `Optional` nonce +### expirationTimeSeconds -• **nonce**? : *undefined | number* +• **expirationTimeSeconds**: *`BigNumber`* -*Inherited from [TransactionOpts](#interface-transactionopts).[nonce](#optional-nonce)* +*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L67)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* ___ -### `Optional` shouldValidate +### gasPrice -• **shouldValidate**? : *undefined | false | true* +• **gasPrice**: *`BigNumber`* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L75)* +*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[gasPrice](#gasprice)* + +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* + +___ + +### salt + +• **salt**: *`BigNumber`* + +*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)* + +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* + +___ + +### signature + +• **signature**: *string* + +*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L54)* + +___ + +### signerAddress + +• **signerAddress**: *string* + +*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)* + +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)* + +
+ +# Interface: SimpleContractArtifact + + +## Properties + +### compilerOutput + +• **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)* + +*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L748)* + +___ + +### contractName + +• **contractName**: *string* + +*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L747)* + +___ + +### networks + +• **networks**: *`ContractNetworks`* + +*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L749)* + +___ + +### schemaVersion + +• **schemaVersion**: *string* + +*Defined in [types/src/index.ts:746](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L746)* + +
+ +# Interface: SimpleEvmBytecodeOutput + + +## Properties + +### object + +• **object**: *string* + +*Defined in [types/src/index.ts:763](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L763)* + +
+ +# Interface: SimpleEvmOutput + + +## Properties + +### bytecode + +• **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)* + +*Defined in [types/src/index.ts:759](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L759)* + +
+ +# Interface: SimpleStandardContractOutput + + +## Properties + +### abi + +• **abi**: *[ContractAbi](#contractabi)* + +*Defined in [types/src/index.ts:753](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L753)* + +___ + +### `Optional` devdoc + +• **devdoc**? : *[DevdocOutput](#class-devdocoutput)* + +*Defined in [types/src/index.ts:755](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L755)* + +___ + +### evm + +• **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)* + +*Defined in [types/src/index.ts:754](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L754)*
@@ -1295,356 +32152,445 @@ ___ -# Class: ContractWrappers - -The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. - - -## Constructors -\+ **new ContractWrappers**(`supportedProvider`: `SupportedProvider`, `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)* -*Defined in [contract_wrappers.ts:84](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L84)* -Instantiates a new ContractWrappers instance. + + + + + + + + + + + + + + + + + + + + + + + + + +# Interface: ZeroExTransaction + +ZeroExTransaction for use with 0x Exchange executeTransaction + + +## Properties + +### data + +• **data**: *string* + +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L49)* + +___ + +### domain + +• **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* + +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L50)* + +___ + +### expirationTimeSeconds + +• **expirationTimeSeconds**: *`BigNumber`* + +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L46)* + +___ + +### gasPrice + +• **gasPrice**: *`BigNumber`* + +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L47)* + +___ + +### salt + +• **salt**: *`BigNumber`* + +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L45)* + +___ + +### signerAddress + +• **signerAddress**: *string* + +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L48)* + +
+ + + +
+ + + + +## Type aliases + +### CoordinatorRegistryEventArgs + +Ƭ **CoordinatorRegistryEventArgs**: *[CoordinatorRegistryCoordinatorEndpointSetEventArgs](#interface-coordinatorregistrycoordinatorendpointseteventargs)* + +*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)* + +
+ + + +
+ + + + +## Type aliases + +### DummyERC20TokenEventArgs + +Ƭ **DummyERC20TokenEventArgs**: *[DummyERC20TokenApprovalEventArgs](#interface-dummyerc20tokenapprovaleventargs) | [DummyERC20TokenTransferEventArgs](#interface-dummyerc20tokentransfereventargs)* + +*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)* + +
+ + + + +## Type aliases + +### DummyERC721TokenEventArgs + +Ƭ **DummyERC721TokenEventArgs**: *[DummyERC721TokenApprovalEventArgs](#interface-dummyerc721tokenapprovaleventargs) | [DummyERC721TokenApprovalForAllEventArgs](#interface-dummyerc721tokenapprovalforalleventargs) | [DummyERC721TokenTransferEventArgs](#interface-dummyerc721tokentransfereventargs)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L28)* + +
+ + + +
+ + + + +## Type aliases + +### ERC1155ProxyEventArgs + +Ƭ **ERC1155ProxyEventArgs**: *[ERC1155ProxyAuthorizedAddressAddedEventArgs](#interface-erc1155proxyauthorizedaddressaddedeventargs) | [ERC1155ProxyAuthorizedAddressRemovedEventArgs](#interface-erc1155proxyauthorizedaddressremovedeventargs)* + +*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)* + +
+ + + + +## Type aliases + +### ERC20ProxyEventArgs + +Ƭ **ERC20ProxyEventArgs**: *[ERC20ProxyAuthorizedAddressAddedEventArgs](#interface-erc20proxyauthorizedaddressaddedeventargs) | [ERC20ProxyAuthorizedAddressRemovedEventArgs](#interface-erc20proxyauthorizedaddressremovedeventargs)* + +*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)* + +
+ + + + +## Type aliases + +### ERC20TokenEventArgs + +Ƭ **ERC20TokenEventArgs**: *[ERC20TokenTransferEventArgs](#interface-erc20tokentransfereventargs) | [ERC20TokenApprovalEventArgs](#interface-erc20tokenapprovaleventargs)* + +*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)* + +
+ + + + +## Type aliases + +### ERC721ProxyEventArgs + +Ƭ **ERC721ProxyEventArgs**: *[ERC721ProxyAuthorizedAddressAddedEventArgs](#interface-erc721proxyauthorizedaddressaddedeventargs) | [ERC721ProxyAuthorizedAddressRemovedEventArgs](#interface-erc721proxyauthorizedaddressremovedeventargs)* + +*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)* + +
+ + + + +## Type aliases + +### ERC721TokenEventArgs + +Ƭ **ERC721TokenEventArgs**: *[ERC721TokenApprovalEventArgs](#interface-erc721tokenapprovaleventargs) | [ERC721TokenApprovalForAllEventArgs](#interface-erc721tokenapprovalforalleventargs) | [ERC721TokenTransferEventArgs](#interface-erc721tokentransfereventargs)* + +*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)* + +
+ + + + +## Type aliases + +### ExchangeEventArgs + +Ƭ **ExchangeEventArgs**: *[ExchangeAssetProxyRegisteredEventArgs](#interface-exchangeassetproxyregisteredeventargs) | [ExchangeCancelEventArgs](#interface-exchangecanceleventargs) | [ExchangeCancelUpToEventArgs](#interface-exchangecanceluptoeventargs) | [ExchangeFillEventArgs](#interface-exchangefilleventargs) | [ExchangeProtocolFeeCollectorAddressEventArgs](#interface-exchangeprotocolfeecollectoraddresseventargs) | [ExchangeProtocolFeeMultiplierEventArgs](#interface-exchangeprotocolfeemultipliereventargs) | [ExchangeSignatureValidatorApprovalEventArgs](#interface-exchangesignaturevalidatorapprovaleventargs) | [ExchangeTransactionExecutionEventArgs](#interface-exchangetransactionexecutioneventargs)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L28)* + +
+ + + +
+ + + +
+ + + +
+ + + +
+ + + + +## Type aliases + +### WETH9EventArgs + +Ƭ **WETH9EventArgs**: *[WETH9ApprovalEventArgs](#interface-weth9approvaleventargs) | [WETH9TransferEventArgs](#interface-weth9transfereventargs) | [WETH9DepositEventArgs](#interface-weth9depositeventargs) | [WETH9WithdrawalEventArgs](#interface-weth9withdrawaleventargs)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:28](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L28)* + +
+ + + + +## Type aliases + +### ZRXTokenEventArgs + +Ƭ **ZRXTokenEventArgs**: *[ZRXTokenTransferEventArgs](#interface-zrxtokentransfereventargs) | [ZRXTokenApprovalEventArgs](#interface-zrxtokenapprovaleventargs)* + +*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)* + +
+ + + + +## Functions + +### getContractAddressesForNetworkOrThrow + +▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)* + +*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/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 +contracts deployed on the corresponding network. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`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. | +`networkId` | [NetworkId](#enumeration-networkid) | The desired networkId. | -**Returns:** *[ContractWrappers](#class-contractwrappers)* +**Returns:** *[ContractAddresses](#interface-contractaddresses)* -An instance of the ContractWrappers class. - -## Properties - -### contractAddresses - -• **contractAddresses**: *`ContractAddresses`* - -*Defined in [contract_wrappers.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L43)* - -An index of the default contract addresses for this network. - -___ - -### coordinator - -• **coordinator**: *[CoordinatorWrapper](#class-coordinatorwrapper)* - -*Defined in [contract_wrappers.ts:82](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L82)* - -An instance of the CoordinatorWrapper class containing methods for interacting with the Coordinator extension contract. - -___ - -### devUtils - -• **devUtils**: *`DevUtilsContract`* - -*Defined in [contract_wrappers.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L78)* - -An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract. - -___ - -### dutchAuction - -• **dutchAuction**: *`DutchAuctionContract`* - -*Defined in [contract_wrappers.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L74)* - -An instance of the DutchAuctionContract class containing methods for interacting with any DutchAuction smart contract. - -___ - -### erc20Proxy - -• **erc20Proxy**: *`ERC20ProxyContract`* - -*Defined in [contract_wrappers.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L52)* - -An instance of the ERC20ProxyContract class containing methods for interacting with the -erc20Proxy smart contract. - -___ - -### erc721Proxy - -• **erc721Proxy**: *`ERC721ProxyContract`* - -*Defined in [contract_wrappers.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L57)* - -An instance of the ERC721ProxyContract class containing methods for interacting with the -erc721Proxy smart contract. - -___ - -### exchange - -• **exchange**: *`ExchangeContract`* - -*Defined in [contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L47)* - -An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. - -___ - -### forwarder - -• **forwarder**: *`ForwarderContract`* - -*Defined in [contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L66)* - -An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. - -___ - -### orderValidator - -• **orderValidator**: *`OrderValidatorContract`* - -*Defined in [contract_wrappers.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L70)* - -An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract. - -___ - -### weth9 - -• **weth9**: *`WETH9Contract`* - -*Defined in [contract_wrappers.ts:62](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L62)* - -An instance of the WETH9Contract class containing methods for interacting with the -WETH9 smart contract. - -## Methods - -### getAbiDecoder - -▸ **getAbiDecoder**(): *`AbiDecoder`* - -*Defined in [contract_wrappers.ts:155](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L155)* - -Get the abi decoder instance currently used by contract-wrappers - -**Returns:** *`AbiDecoder`* - -AbiDecoder instance - -___ - -### getProvider - -▸ **getProvider**(): *`SupportedProvider`* - -*Defined in [contract_wrappers.ts:148](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L148)* - -Get the provider instance currently used by contract-wrappers - -**Returns:** *`SupportedProvider`* - -Web3 provider instance - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract_wrappers.ts:138](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L138)* - -Unsubscribes from all subscriptions for all contracts. - -**Returns:** *void* +The set of addresses for contracts which have been deployed on the +given networkId.
-# Interface: CoordinatorOutstandingFillSignatures -## Properties +
-### approvalSignatures -• **approvalSignatures**: *string[]* -*Defined in [utils/coordinator_server_types.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L19)* +
+ + + +
+ + + + +## Type aliases + +### AbiDefinition + +Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)* + +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L80)* ___ -### expirationTimeSeconds +### BlockParam -• **expirationTimeSeconds**: *`BigNumber`* +Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [utils/coordinator_server_types.ts:20](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L20)* +*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L483)* ___ -### orderHash +### ConstructorStateMutability -• **orderHash**: *string* +Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [utils/coordinator_server_types.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L18)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L84)* ___ -### takerAssetFillAmount +### ContractAbi -• **takerAssetFillAmount**: *`BigNumber`* +Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [utils/coordinator_server_types.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L21)* - -
- -# Interface: CoordinatorServerApprovalRawResponse - - -## Properties - -### expirationTimeSeconds - -• **expirationTimeSeconds**: *`BigNumber`* - -*Defined in [utils/coordinator_server_types.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L10)* +*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L78)* ___ -### signatures +### ContractEventArg -• **signatures**: *string[]* +Ƭ **ContractEventArg**: *any* -*Defined in [utils/coordinator_server_types.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L9)* - -
- -# Interface: CoordinatorServerApprovalResponse - - -## Properties - -### expirationTimeSeconds - -• **expirationTimeSeconds**: *`BigNumber`[]* - -*Defined in [utils/coordinator_server_types.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L6)* +*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L468)* ___ -### signatures - -• **signatures**: *string[]* - -*Defined in [utils/coordinator_server_types.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L5)* - -
- -# Interface: CoordinatorServerCancellationResponse -## Properties +### EIP1193Event -### cancellationSignatures +Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -• **cancellationSignatures**: *string[]* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L70)* -*Defined in [utils/coordinator_server_types.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L15)* +Interface for providers that conform to EIP 1193 +Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md ___ -### outstandingFillSignatures - -• **outstandingFillSignatures**: *[CoordinatorOutstandingFillSignatures](#class-coordinatoroutstandingfillsignatures)[]* - -*Defined in [utils/coordinator_server_types.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L14)* - -
- -# Interface: CoordinatorServerRequest -## Properties -### signedTransaction -• **signedTransaction**: *`SignedZeroExTransaction`* +### FunctionAbi -*Defined in [utils/coordinator_server_types.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L35)* +Ƭ **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/9fe6c196a/packages/ethereum-types/src/index.ts#L82)* ___ -### txOrigin +### JSONRPCErrorCallback -• **txOrigin**: *string* +Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [utils/coordinator_server_types.ts:36](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L36)* +*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: -# Interface: CoordinatorServerResponse +▸ (`err`: `Error` | null, `result?`: [JSONRPCResponsePayload](#interface-jsonrpcresponsepayload)): *void* +**Parameters:** -## Properties - -### `Optional` body - -• **body**? : *[CoordinatorServerCancellationResponse](_utils_coordinator_server_types_.coordinatorservercancellationresponse.md) | [CoordinatorServerApprovalRawResponse](#class-coordinatorserverapprovalrawresponse)* - -*Defined in [utils/coordinator_server_types.ts:27](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L27)* +Name | Type | +------ | ------ | +`err` | `Error` \| null | +`result?` | [JSONRPCResponsePayload](#interface-jsonrpcresponsepayload) | ___ -### coordinatorOperator -• **coordinatorOperator**: *string* -*Defined in [utils/coordinator_server_types.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L30)* +### OutputField + +Ƭ **OutputField**: *"*" | "ast" | "legacyAST" | "abi" | "devdoc" | "userdoc" | "metadata" | "ir" | "evm.assembly" | "evm.legacyAssembly" | "evm.bytecode.object" | "evm.bytecode.opcodes" | "evm.bytecode.sourceMap" | "evm.bytecode.linkReferences" | "evm.deployedBytecode.object" | "evm.deployedBytecode.opcodes" | "evm.deployedBytecode.sourceMap" | "evm.deployedBytecode.linkReferences" | "evm.methodIdentifiers" | "evm.gasEstimates" | "ewasm.wast" | "ewasm.wasm"* + +*Defined in [ethereum-types/src/index.ts:525](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L525)* ___ -### `Optional` error +### ParamDescription -• **error**? : *any* +Ƭ **ParamDescription**: *string* -*Defined in [utils/coordinator_server_types.ts:28](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L28)* +*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L561)* ___ -### isError +### RawLog -• **isError**: *boolean* +Ƭ **RawLog**: *[LogEntry](#interface-logentry)* -*Defined in [utils/coordinator_server_types.ts:25](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L25)* +*Defined in [ethereum-types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L475)* ___ -### `Optional` orders +### StateMutability -• **orders**? : *`Array`* +Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [utils/coordinator_server_types.ts:31](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L31)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L85)* ___ -### request +### SupportedProvider -• **request**: *[CoordinatorServerRequest](#class-coordinatorserverrequest)* +Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [utils/coordinator_server_types.ts:29](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L29)* +*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. ___ -### status -• **status**: *number* -*Defined in [utils/coordinator_server_types.ts:26](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L26)* + + +### Web3JsProvider + +Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* + +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/ethereum-types/src/index.ts#L11)*
@@ -1653,255 +32599,23 @@ ___ ## Type aliases -### AsyncMethod -Ƭ **AsyncMethod**: *function* -*Defined in [utils/decorators.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L18)* -#### Type declaration: -▸ (...`args`: any[]): *`Promise`* -**Parameters:** -Name | Type | ------- | ------ | -`...args` | any[] | -___ -### SyncMethod -Ƭ **SyncMethod**: *function* -*Defined in [utils/decorators.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L19)* - -#### Type declaration: - -▸ (...`args`: any[]): *any* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -## Object literals - -### `Const` decorators - -#### ▪ **decorators**: *object* - -*Defined in [utils/decorators.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L130)* - -#### asyncZeroExErrorHandler - -• **asyncZeroExErrorHandler**: *`asyncErrorHandlingDecorator`* = asyncErrorHandlerFactory(zeroExErrorTransformer) - -*Defined in [utils/decorators.ts:131](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L131)* - -#### syncZeroExErrorHandler - -• **syncZeroExErrorHandler**: *`syncErrorHandlingDecorator`* = syncErrorHandlerFactory(zeroExErrorTransformer) - -*Defined in [utils/decorators.ts:132](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/decorators.ts#L132)* - -
- - - -
- - - -
- - - -
- - - -
- - - - -## Object literals - -#### `Const` ContractWrappersConfigSchema - -#### ▪ **ContractWrappersConfigSchema**: *object* - -*Defined in [schemas/contract_wrappers_config_schema.ts:1](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/contract_wrappers_config_schema.ts#L1)* - -#### id - -• **id**: *string* = "/ContractWrappersConfig" - -*Defined in [schemas/contract_wrappers_config_schema.ts:2](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/contract_wrappers_config_schema.ts#L2)* - -#### required - -• **required**: *string[]* = ['networkId'] - -*Defined in [schemas/contract_wrappers_config_schema.ts:24](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/contract_wrappers_config_schema.ts#L24)* - -#### type - -• **type**: *string* = "object" - -*Defined in [schemas/contract_wrappers_config_schema.ts:23](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/contract_wrappers_config_schema.ts#L23)* - -▪ **properties**: *object* - -*Defined in [schemas/contract_wrappers_config_schema.ts:3](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/contract_wrappers_config_schema.ts#L3)* - -* **blockPollingIntervalMs**: *object* - - * **type**: *string* = "number" - -* **contractAddresses**: *object* - - * **type**: *string* = "object" - - * **properties**: *object* - - * **assetProxyOwner**: *object* - - * **$ref**: *string* = "/addressSchema" - - * **erc20Proxy**: *object* - - * **$ref**: *string* = "/addressSchema" - - * **erc721Proxy**: *object* - - * **$ref**: *string* = "/addressSchema" - - * **etherToken**: *object* - - * **$ref**: *string* = "/addressSchema" - - * **exchange**: *object* - - * **$ref**: *string* = "/addressSchema" - - * **forwarder**: *object* - - * **$ref**: *string* = "/addressSchema" - - * **orderValidator**: *object* - - * **$ref**: *string* = "/addressSchema" - - * **zrxToken**: *object* - - * **$ref**: *string* = "/addressSchema" - -* **gasPrice**: *object* - - * **$ref**: *string* = "/numberSchema" - -* **networkId**: *object* - - * **type**: *string* = "number" - -
- - - - -## Object literals - -#### `Const` orderTxOptsSchema - -#### ▪ **orderTxOptsSchema**: *object* - -*Defined in [schemas/order_tx_opts_schema.ts:1](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/order_tx_opts_schema.ts#L1)* - -#### allOf - -• **allOf**: *object[]* = [{ $ref: '/TxOpts' }] - -*Defined in [schemas/order_tx_opts_schema.ts:3](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/order_tx_opts_schema.ts#L3)* - -#### id - -• **id**: *string* = "/OrderTxOpts" - -*Defined in [schemas/order_tx_opts_schema.ts:2](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/order_tx_opts_schema.ts#L2)* - -#### type - -• **type**: *string* = "object" - -*Defined in [schemas/order_tx_opts_schema.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/order_tx_opts_schema.ts#L7)* - -▪ **properties**: *object* - -*Defined in [schemas/order_tx_opts_schema.ts:4](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/order_tx_opts_schema.ts#L4)* - -* **shouldValidate**: *object* - - * **type**: *string* = "boolean" - -
- - - - -## Object literals - -#### `Const` txOptsSchema - -#### ▪ **txOptsSchema**: *object* - -*Defined in [schemas/tx_opts_schema.ts:1](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/tx_opts_schema.ts#L1)* - -#### id - -• **id**: *string* = "/TxOpts" - -*Defined in [schemas/tx_opts_schema.ts:2](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/tx_opts_schema.ts#L2)* - -#### type - -• **type**: *string* = "object" - -*Defined in [schemas/tx_opts_schema.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/tx_opts_schema.ts#L8)* - -▪ **properties**: *object* - -*Defined in [schemas/tx_opts_schema.ts:3](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/schemas/tx_opts_schema.ts#L3)* - -* **gasLimit**: *object* - - * **type**: *string* = "number" - -* **gasPrice**: *object* - - * **$ref**: *string* = "/numberSchema" - -* **nonce**: *object* - - * **type**: *string* = "number" - -
- - - - -## Type aliases - -#### EventCallback +### EventCallback Ƭ **EventCallback**: *function* -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L11)* +*Defined in [types/src/index.ts:857](https://github.com/0xProject/0x-monorepo/blob/9fe6c196a/packages/types/src/index.ts#L857)* -##### Type declaration: +#### Type declaration: ▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void* @@ -1912,183 +32626,17 @@ Name | Type | `err` | null \| `Error` | `log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› | -
+___ -## Object literals -#### `Const` assert -#### ▪ **assert**: *object* -*Defined in [utils/assert.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L13)* -#### allMakerAssetDatasAreErc20Token -▸ **allMakerAssetDatasAreErc20Token**(`orders`: `Order`[], `tokenAddress`: string): *void* -*Defined in [utils/assert.ts:61](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L61)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Order`[] | -`tokenAddress` | string | - -**Returns:** *void* - -#### allTakerAddressesAreNull - -▸ **allTakerAddressesAreNull**(`orders`: `Order`[]): *void* - -*Defined in [utils/assert.ts:58](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L58)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Order`[] | - -**Returns:** *void* - -#### allTakerAssetDatasAreErc20Token - -▸ **allTakerAssetDatasAreErc20Token**(`orders`: `Order`[], `tokenAddress`: string): *void* - -*Defined in [utils/assert.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L68)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Order`[] | -`tokenAddress` | string | - -**Returns:** *void* - -#### feeOrdersCanBeUsedForForwarderContract - -▸ **feeOrdersCanBeUsedForForwarderContract**(`orders`: `Order`[], `zrxTokenAddress`: string, `etherTokenAddress`: string): *void* - -*Defined in [utils/assert.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L52)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Order`[] | -`zrxTokenAddress` | string | -`etherTokenAddress` | string | - -**Returns:** *void* - -#### isSenderAddressAsync - -▸ **isSenderAddressAsync**(`variableName`: string, `senderAddressHex`: string, `web3Wrapper`: `Web3Wrapper`): *`Promise`* - -*Defined in [utils/assert.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L34)* - -**Parameters:** - -Name | Type | ------- | ------ | -`variableName` | string | -`senderAddressHex` | string | -`web3Wrapper` | `Web3Wrapper` | - -**Returns:** *`Promise`* - -#### isValidSignatureAsync - -▸ **isValidSignatureAsync**(`supportedProvider`: `SupportedProvider`, `orderHash`: string, `signature`: string, `signerAddress`: string): *`Promise`* - -*Defined in [utils/assert.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L15)* - -**Parameters:** - -Name | Type | ------- | ------ | -`supportedProvider` | `SupportedProvider` | -`orderHash` | string | -`signature` | string | -`signerAddress` | string | - -**Returns:** *`Promise`* - -#### isValidSubscriptionToken - -▸ **isValidSubscriptionToken**(`variableName`: string, `subscriptionToken`: string): *void* - -*Defined in [utils/assert.ts:29](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L29)* - -**Parameters:** - -Name | Type | ------- | ------ | -`variableName` | string | -`subscriptionToken` | string | - -**Returns:** *void* - -#### ordersCanBeUsedForForwarderContract - -▸ **ordersCanBeUsedForForwarderContract**(`orders`: `Order`[], `etherTokenAddress`: string): *void* - -*Defined in [utils/assert.ts:46](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L46)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Order`[] | -`etherTokenAddress` | string | - -**Returns:** *void* - -#### ordersHaveAtMostOneUniqueValueForProperty - -▸ **ordersHaveAtMostOneUniqueValueForProperty**(`orders`: `Order`[], `propertyName`: string, `value?`: any): *void* - -*Defined in [utils/assert.ts:79](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/assert.ts#L79)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orders` | `Order`[] | -`propertyName` | string | -`value?` | any | - -**Returns:** *void* - -
- - - - -## Functions - -#### _getDefaultContractAddresses - -▸ **_getDefaultContractAddresses**(`networkId`: number): *`ContractAddresses`* - -*Defined in [utils/contract_addresses.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/utils/contract_addresses.ts#L8)* - -Returns the default contract addresses for the given networkId or throws with -a context-specific error message if the networkId is not recognized. - -**Parameters:** - -Name | Type | ------- | ------ | -`networkId` | number | - -**Returns:** *`ContractAddresses`* - -
diff --git a/packages/contracts-gen/CHANGELOG.json b/packages/contracts-gen/CHANGELOG.json index 52ffa3a43c..cbaad0fafc 100644 --- a/packages/contracts-gen/CHANGELOG.json +++ b/packages/contracts-gen/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Fixed sorting in artifact generation", "pr": 1910 } - ] + ], + "timestamp": 1570135330 }, { "timestamp": 1568744790, diff --git a/packages/contracts-gen/CHANGELOG.md b/packages/contracts-gen/CHANGELOG.md index eb35386b98..874b994727 100644 --- a/packages/contracts-gen/CHANGELOG.md +++ b/packages/contracts-gen/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## 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) + * Fixed sorting in artifact generation (#1910) + ## v1.0.15 - _September 17, 2019_ * Dependencies updated diff --git a/packages/dev-tools-pages/public/bundle-compiler-animation.350d539fdb811c75be5d.js b/packages/dev-tools-pages/public/bundle-compiler-animation.350d539fdb811c75be5d.js new file mode 100644 index 0000000000..9da7319c26 --- /dev/null +++ b/packages/dev-tools-pages/public/bundle-compiler-animation.350d539fdb811c75be5d.js @@ -0,0 +1,2 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[5],{176:function(i){i.exports={v:"5.4.1",fr:30,ip:0,op:420,w:4300,h:1400,nm:"header-compiler",ddd:0,assets:[],layers:[{ddd:0,ind:2,ty:4,nm:"Path Copy 3",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[328.5,911.5,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-61.75,-99.75],[99.75,61.75],[61.75,99.75],[-99.75,-61.75]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path Copy 3",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:3,ty:4,nm:"Path",parent:16,sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[-280,-180,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-39.25,87.75],[87.75,-39.25],[39.25,-87.75],[-87.75,39.25]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:4,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[1261.5,738.5,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[15.75,82.75],[82.75,15.75],[-15.75,-82.75],[-82.75,-15.75]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:5,ty:4,nm:"Path",parent:12,sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[370,-209,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[23.25,-23.25],[-23.25,23.25]],c:!1},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:6,ty:4,nm:"Path",parent:12,sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[347,-269,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-60.25,-60.25],[60.25,60.25]],c:!1},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:7,ty:4,nm:"Path",parent:12,sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[330,-250,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-37.25,-84.25],[84.25,37.25],[37.25,84.25],[-84.25,-37.25]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:8,ty:4,nm:"Path Copy",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:180,s:[449.5,348.5,0],e:[223.5,574.5,0],to:[-37.6666679382324,37.6666679382324,0],ti:[37.6666679382324,-37.6666679382324,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:210,s:[223.5,574.5,0],e:[223.5,574.5,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:390.5,s:[223.5,574.5,0],e:[449.5,348.5,0],to:[37.6666679382324,-37.6666679382324,0],ti:[-37.6666679382324,37.6666679382324,0]},{t:420}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[9.42,-69.25],[-69.25,9.42],[-9.42,69.25],[69.25,-9.42]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path Copy",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:9,ty:4,nm:"Shape Layer 2",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[2150,700,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:180,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-1935,-90],[-1765,-260]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-2020,87],[-1946,13]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:210,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-2020,87],[-1946,13]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-2020,87],[-1946,13]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:390,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-2020,87],[-1946,13]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-1935,-90],[-1765,-260]],c:!1}]},{t:420}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117647066303,.678431372549,.803921628466,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:4,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"fl",c:{a:0,k:[1,0,0,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!0},{ty:"tr",p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:180,s:[1,-1],e:[0,0],to:[-.16666667163372,.16666667163372],ti:[.16666667163372,-.16666667163372]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:210,s:[0,0],e:[0,0],to:[0,0],ti:[0,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:390,s:[0,0],e:[1,-1],to:[.16666667163372,-.16666667163372],ti:[-.16666667163372,.16666667163372]},{t:420}],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[100,100],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Shape 1",np:3,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:527,st:0,bm:0},{ddd:0,ind:10,ty:4,nm:"Shape Layer 1",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:180,s:[2150,700,0],e:[1920,930,0],to:[-38.3333320617676,38.3333320617676,0],ti:[38.3333320617676,-38.3333320617676,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:210,s:[1920,930,0],e:[1920,930,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:390,s:[1920,930,0],e:[2150,700,0],to:[38.3333320617676,-38.3333320617676,0],ti:[-38.3333320617676,38.3333320617676,0]},{t:420}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:180,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-1806,-241],[-1748,-183]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-1750,-185],[-1748,-183]],c:!0}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:210,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-1750,-185],[-1748,-183]],c:!0}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-1750,-185],[-1748,-183]],c:!0}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:390,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-1750,-185],[-1748,-183]],c:!0}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-1806,-241],[-1748,-183]],c:!1}]},{t:420}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117647066303,.678431372549,.803921628466,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:4,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!0},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[100,100],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Shape 1",np:3,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:527,st:0,bm:0},{ddd:0,ind:11,ty:4,nm:"Path Copy 2",parent:8,sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[-134,194,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:180,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[28.03,-56.75],[-56.75,28.03],[-28.03,56.75],[56.75,-28.03]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[56.53,-28.25],[20.5,9.03],[20.72,9.25],[56.75,-28.03]],c:!0}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:210,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[56.53,-28.25],[20.5,9.03],[20.72,9.25],[56.75,-28.03]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[56.53,-28.25],[20.5,9.03],[20.72,9.25],[56.75,-28.03]],c:!0}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:391,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[56.53,-28.25],[20.5,9.03],[20.72,9.25],[56.75,-28.03]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[28.03,-56.75],[-56.75,28.03],[-28.03,56.75],[56.75,-28.03]],c:!0}]},{t:421}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path Copy 2",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:12,ty:4,nm:"Big block",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[571.5,588.5,0],e:[697.5,462.5,0],to:[21,-21,0],ti:[-21,21,0]},{i:{x:.667,y:.667},o:{x:.167,y:.167},n:"0p667_0p667_0p167_0p167",t:120,s:[697.5,462.5,0],e:[697.5,462.5,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.833,y:1},o:{x:.333,y:0},n:"0p833_1_0p333_0",t:300,s:[697.5,462.5,0],e:[571.5,588.5,0],to:[-21,21,0],ti:[21,-21,0]},{t:330}],ix:2},a:{a:0,k:[2,-2,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ty:"st",c:{a:0,k:[.117646998985,.67843095368,.803921987496,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[100,100],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Shape 1",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1},{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[60.75,-182.25],[-182.25,60.75],[-60.75,182.25],[182.25,-60.75]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:2,mn:"ADBE Vector Group",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:13,ty:4,nm:"Path Copy 4",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[389.5,770.5,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-92.25,-29.25],[-92.25,-29.25],[29.25,92.25],[29.25,92.25]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-29.25,-92.25],[-92.25,-29.25],[29.25,92.25],[92.25,29.25]],c:!0}]},{t:120}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path Copy 4",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:14,ty:4,nm:"Path Copy 9",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[273,647,0],e:[317,695,0],to:[7.33333349227905,8,0],ti:[-7.33333349227905,-8,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:120,s:[317,695,0],e:[317,695,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.833,y:1},o:{x:.333,y:0},n:"0p833_1_0p333_0",t:300,s:[317,695,0],e:[273,647,0],to:[-7.33333349227905,-8,0],ti:[7.33333349227905,8,0]},{t:330}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[30.75,-31.25],[-31.5,31]],c:!1},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path Copy 9",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:15,ty:4,nm:"Path Copy 8",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[329,832,0],e:[349,812,0],to:[3.33333325386047,-3.33333325386047,0],ti:[-3.33333325386047,3.33333325386047,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:120,s:[349,812,0],e:[349,812,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.833,y:1},o:{x:.333,y:0},n:"0p833_1_0p333_0",t:300,s:[349,812,0],e:[329,832,0],to:[-3.33333325386047,3.33333325386047,0],ti:[3.33333325386047,-3.33333325386047,0]},{t:330}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-61,-61],[61,61]],c:!1},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path Copy 8",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:16,ty:4,nm:"wide box",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[971.5,988.5,0],e:[1096.5,864.5,0],to:[10.0566339492798,-9.97618103027344,0],ti:[0,0,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:120,s:[1096.5,864.5,0],e:[1096.5,864.5,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.833,y:1},o:{x:.333,y:0},n:"0p833_1_0p333_0",t:300,s:[1096.5,864.5,0],e:[971.5,988.5,0],to:[0,0,0],ti:[-20.8333339691162,20.6666660308838,0]},{t:330}],ix:2},a:{a:0,k:[-1,1,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-129.25,-52.25],[-52.25,-129.25],[129.25,52.25],[52.25,129.25]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:17,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[993,766,0],e:[1071,688,0],to:[13,-13,0],ti:[-13,13,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:120,s:[1071,688,0],e:[1071,688,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.833,y:1},o:{x:.333,y:0},n:"0p833_1_0p333_0",t:300,s:[1071,688,0],e:[993,766,0],to:[-13,13,0],ti:[13,-13,0]},{t:330}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-89.5,-89.5],[89.5,89.5]],c:!1},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:18,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[1115,850,0],e:[1311.5,799.5,0],to:[18.5410747528076,-4.90381097793579,0],ti:[-5.73690891265869,1.51731848716736,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:120,s:[1311.5,799.5,0],e:[1311.5,799.5,0],to:[33.0833320617676,-8.75,0],ti:[5.73690891265869,-1.51731848716736,0]},{i:{x:.833,y:1},o:{x:.333,y:0},n:"0p833_1_0p333_0",t:300,s:[1311.5,799.5,0],e:[1115,850,0],to:[-5.73690891265869,1.51731848716736,0],ti:[-33.0833320617676,8.75,0]},{t:330}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[103.689,103.689,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[30.5,-30.5],[-30.5,30.5]],c:!1},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:19,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[1011.5,748.5,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.833,y:.833},o:{x:.333,y:0},n:"0p833_0p833_0p333_0",t:90,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[120.75,57.75],[58.25,120.25],[-120.25,-58.25],[-57.75,-120.75]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[120.514,57.986],[119.427,59.073],[-59.073,-119.427],[-57.986,-120.514]],c:!0}]},{i:{x:.833,y:.833},o:{x:.167,y:.167},n:"0p833_0p833_0p167_0p167",t:120,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[120.514,57.986],[119.427,59.073],[-59.073,-119.427],[-57.986,-120.514]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[120.514,57.986],[119.427,59.073],[-59.073,-119.427],[-57.986,-120.514]],c:!0}]},{i:{x:.833,y:1},o:{x:.167,y:.167},n:"0p833_1_0p167_0p167",t:300,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[120.514,57.986],[119.427,59.073],[-59.073,-119.427],[-57.986,-120.514]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[120.75,57.75],[58.25,120.25],[-120.25,-58.25],[-57.75,-120.75]],c:!0}]},{t:330}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1},{ty:"gr",it:[{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[100,100],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Group 1",np:0,cix:2,ix:2,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:20,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[3620,905,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[33,163],[-163,-33],[-33,-163],[163,33]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:21,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[3274,751,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[86,-140],[140,-86],[-86,140],[-140,86]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:22,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[3770,475,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-2,-162],[162,2],[2,162],[-162,-2]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:23,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[3465,340,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[80,-24],[24,-80],[-82,26],[-26,82]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:24,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[3420.5,966.5,0],e:[3389.5,996.5,0],to:[-5.16666650772095,5,0],ti:[5.16666650772095,-5,0]},{i:{x:.667,y:.667},o:{x:.167,y:.167},n:"0p667_0p667_0p167_0p167",t:120,s:[3389.5,996.5,0],e:[3389.5,996.5,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[3389.5,996.5,0],e:[3420.5,966.5,0],to:[5.16666650772095,-5,0],ti:[-5.16666650772095,5,0]},{t:330}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-62.75,-62.75],[-62.25,-62.25]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-62.75,-62.75],[62.75,62.75]],c:!1}]},{i:{x:.667,y:1},o:{x:.167,y:0},n:"0p667_1_0p167_0",t:120,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-62.75,-62.75],[62.75,62.75]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-62.75,-62.75],[62.75,62.75]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-62.75,-62.75],[62.75,62.75]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-62.75,-62.75],[-62.25,-62.25]],c:!1}]},{t:330}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:25,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[3219.5,915.5,0],e:[3339.5,1035.5,0],to:[20,20,0],ti:[-20,-20,0]},{i:{x:.667,y:.667},o:{x:.167,y:.167},n:"0p667_0p667_0p167_0p167",t:120,s:[3339.5,1035.5,0],e:[3339.5,1035.5,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[3339.5,1035.5,0],e:[3219.5,915.5,0],to:[-20,-20,0],ti:[20,20,0]},{t:330}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[38.25,-38.25],[38.25,-38.25]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[38.25,-38.25],[-38.25,38.25]],c:!1}]},{i:{x:.667,y:1},o:{x:.167,y:0},n:"0p667_1_0p167_0",t:120,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[38.25,-38.25],[-38.25,38.25]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[38.25,-38.25],[-38.25,38.25]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[38.25,-38.25],[-38.25,38.25]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[38.25,-38.25],[38.25,-38.25]],c:!1}]},{t:330}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:26,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[3344,1041,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[42,42],[0,0],[0,0],[0,0]],v:[[-25,-101],[-24,-100],[-24.5,-99.5],[-25.5,-100.5]],c:!1}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-25,-101],[101,25],[25,101],[-101,-25]],c:!1}]},{i:{x:.667,y:1},o:{x:.167,y:0},n:"0p667_1_0p167_0",t:120,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-25,-101],[101,25],[25,101],[-101,-25]],c:!1}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-25,-101],[101,25],[25,101],[-101,-25]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[-25,-101],[101,25],[25,101],[-101,-25]],c:!1}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[42,42],[0,0],[0,0],[0,0]],v:[[-25,-101],[-24,-100],[-24.5,-99.5],[-25.5,-100.5]],c:!1}]},{t:330}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:27,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[3142.5,483.5,0],e:[3266.5,359.5,0],to:[20.6666660308838,-20.6666660308838,0],ti:[-20.6666660308838,20.6666660308838,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:120,s:[3266.5,359.5,0],e:[3266.5,359.5,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[3266.5,359.5,0],e:[3142.5,483.5,0],to:[-20.6666660308838,20.6666660308838,0],ti:[20.6666660308838,-20.6666660308838,0]},{t:330}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-73.25,-73.25],[73.25,73.25]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-33.25,-33.25],[73.25,73.25]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:120,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-33.25,-33.25],[73.25,73.25]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-33.25,-33.25],[73.25,73.25]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-33.25,-33.25],[73.25,73.25]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[-73.25,-73.25],[73.25,73.25]],c:!1}]},{t:329.5}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:28,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[3163,420,0],e:[3327,588,0],to:[27.3333339691162,28,0],ti:[-27.3333339691162,-28,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:120,s:[3327,588,0],e:[3327,588,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[3327,588,0],e:[3163,420,0],to:[-27.3333339691162,-28,0],ti:[27.3333339691162,28,0]},{t:330}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[42,-42],[-42,42]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[42,-42],[42.312,-42.125]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:120,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[42,-42],[42.312,-42.125]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[42,-42],[42.312,-42.125]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[42,-42],[42.312,-42.125]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[42,-42],[-42,42]],c:!1}]},{t:330}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:29,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[3184,441,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[31,115],[-115,-31],[-31,-115],[115,31]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[113.5,31.5],[8,-74],[8,-74],[113.5,31.5]],c:!0}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:120,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[113.5,31.5],[8,-74],[8,-74],[113.5,31.5]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[113.5,31.5],[8,-74],[8,-74],[113.5,31.5]],c:!0}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[113.5,31.5],[8,-74],[8,-74],[113.5,31.5]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[31,115],[-115,-31],[-31,-115],[115,31]],c:!0}]},{t:330}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:30,ty:4,nm:"Path",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:90,s:[2954,751,0],e:[3120,585,0],to:[27.6666660308838,-27.6666660308838,0],ti:[-27.6666660308838,27.6666660308838,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:120,s:[3120,585,0],e:[3120,585,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:300,s:[3120,585,0],e:[2954,751,0],to:[-27.6666660308838,27.6666660308838,0],ti:[27.6666660308838,-27.6666660308838,0]},{t:330}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[146,-40],[40,-146],[-146,40],[-40,146]],c:!0},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117646999657,.678430974483,.803921997547,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:2,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[200,200],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Path",np:2,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:420,st:0,bm:0},{ddd:0,ind:31,ty:4,nm:"Shape Layer 5",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:188,s:[2046,804,0],e:[2150,700,0],to:[17.3333339691162,-17.3333339691162,0],ti:[-17.3333339691162,17.3333339691162,0]},{i:{x:.667,y:.667},o:{x:.333,y:.333},n:"0p667_0p667_0p333_0p333",t:210,s:[2150,700,0],e:[2150,700,0],to:[0,0,0],ti:[0,0,0]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:390,s:[2150,700,0],e:[2046,804,0],to:[-17.3333339691162,17.3333339691162,0],ti:[17.3333339691162,-17.3333339691162,0]},{t:410}],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:180,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1727,-6],[1858,125]],c:!0}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1727,-6],[1968,235]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:210,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1727,-6],[1968,235]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1727,-6],[1968,235]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:390,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1727,-6],[1968,235]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1727,-6],[1858,125]],c:!0}]},{t:420}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117647066303,.678431372549,.803921628466,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:4,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[100,100],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Shape 1",np:3,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:527,st:0,bm:0},{ddd:0,ind:32,ty:4,nm:"Shape Layer 4",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[2120,670,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:180,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1684,158],[1685,157]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1746,220],[1963,3]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:210,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1746,220],[1963,3]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1746,220],[1963,3]],c:!1}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:390,s:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1746,220],[1963,3]],c:!1}],e:[{i:[[0,0],[0,0]],o:[[0,0],[0,0]],v:[[1684,158],[1685,157]],c:!1}]},{t:420}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117647066303,.678431372549,.803921628466,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:4,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[100,100],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Shape 1",np:3,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1}],ip:0,op:527,st:0,bm:0},{ddd:0,ind:33,ty:4,nm:"Shape Layer 3",sr:1,ks:{o:{a:0,k:100,ix:11},r:{a:0,k:0,ix:10},p:{a:0,k:[3138,417,0],ix:2},a:{a:0,k:[0,0,0],ix:1},s:{a:0,k:[100,100,100],ix:6}},ao:0,shapes:[{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:0,k:{i:[[0,0]],o:[[0,0]],v:[[-2516,745]],c:!1},ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117647066303,.678431372549,.803921628466,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:4,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1},{ty:"tr",p:{a:0,k:[1,-1],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[100,100],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Shape 2",np:3,cix:2,ix:1,mn:"ADBE Vector Group",hd:!1},{ty:"gr",it:[{ind:0,ty:"sh",ix:1,ks:{a:1,k:[{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:180,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[636,382],[636,382],[766,512],[766,512]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[854,164],[636,382],[876,622],[1094,404]],c:!0}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:210,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[854,164],[636,382],[876,622],[1094,404]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[854,164],[636,382],[876,622],[1094,404]],c:!0}]},{i:{x:.667,y:1},o:{x:.333,y:0},n:"0p667_1_0p333_0",t:390,s:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[854,164],[636,382],[876,622],[1094,404]],c:!0}],e:[{i:[[0,0],[0,0],[0,0],[0,0]],o:[[0,0],[0,0],[0,0],[0,0]],v:[[636,382],[636,382],[766,512],[766,512]],c:!0}]},{t:420}],ix:2},nm:"Path 1",mn:"ADBE Vector Shape - Group",hd:!1},{ty:"st",c:{a:0,k:[.117647066303,.678431372549,.803921628466,1],ix:3},o:{a:0,k:100,ix:4},w:{a:0,k:4,ix:5},lc:1,lj:1,ml:4,ml2:{a:0,k:4,ix:8},nm:"Stroke 1",mn:"ADBE Vector Graphic - Stroke",hd:!1},{ty:"fl",c:{a:0,k:[1,1,1,1],ix:4},o:{a:0,k:100,ix:5},r:1,nm:"Fill 1",mn:"ADBE Vector Graphic - Fill",hd:!1},{ty:"tr",p:{a:0,k:[0,0],ix:2},a:{a:0,k:[0,0],ix:1},s:{a:0,k:[100,100],ix:3},r:{a:0,k:0,ix:6},o:{a:0,k:100,ix:7},sk:{a:0,k:0,ix:4},sa:{a:0,k:0,ix:5},nm:"Transform"}],nm:"Shape 1",np:3,cix:2,ix:2,mn:"ADBE Vector Group",hd:!1}],ip:0,op:527,st:0,bm:0}],markers:[{tm:90,cm:"1",dr:0},{tm:120,cm:"2",dr:0},{tm:180,cm:"3",dr:0},{tm:210,cm:"4",dr:0},{tm:300,cm:"5",dr:0},{tm:330,cm:"6",dr:0},{tm:390,cm:"7",dr:0},{tm:420,cm:"8",dr:0}]}},79:function(i,a,t){"use strict";Object.defineProperty(a,"__esModule",{value:!0});var x=t(0),o=t(85),k=t(176);a.CompilerAnimation=function(){return x.createElement(o.BaseAnimation,{animationData:k,width:2150,height:700})}},85:function(i,a,t){"use strict";var x,o=this&&this.__extends||(x=function(i,a){return(x=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(i,a){i.__proto__=a}||function(i,a){for(var t in a)a.hasOwnProperty(t)&&(i[t]=a[t])})(i,a)},function(i,a){function t(){this.constructor=i}x(i,a),i.prototype=null===a?Object.create(a):(t.prototype=a.prototype,new t)}),k=this&&this.__makeTemplateObject||function(i,a){return Object.defineProperty?Object.defineProperty(i,"raw",{value:a}):i.raw=a,i};Object.defineProperty(a,"__esModule",{value:!0});var n=t(0),r=t(96),p=t(1),s=t(2),e=function(i){function a(){var a=null!==i&&i.apply(this,arguments)||this;return a.state={height:void 0,width:void 0},a._timeout=void 0,a}return o(a,i),a.prototype.componentDidMount=function(){this._updateAnimationSize(),window.addEventListener("resize",this._handleResize.bind(this))},a.prototype.componentWillUnmount=function(){window.removeEventListener("resize",this._handleResize.bind(this))},a.prototype.render=function(){var i=this.props.animationData,a=this.state.height||this.props.height,t=this.state.width||this.props.width;return n.createElement(y,{height:a},n.createElement(d,null,n.createElement(r.default,{width:t,height:a,options:{loop:!0,autoplay:!0,animationData:i}})))},a.prototype._handleResize=function(){clearTimeout(this._timeout),this._timeout=window.setTimeout(this._updateAnimationSize.bind(this),50)},a.prototype._updateAnimationSize=function(){var i,a,t=window.innerWidth;if(t<=1e3){var x=(t+250)/this.props.width;a=Math.round(this.props.height*x),i=Math.round(this.props.width*x)}this.setState({width:i,height:a})},a}(n.PureComponent);a.BaseAnimation=e;var m,c,h,y=p.default.div(c||(c=k(["\n width: 100%;\n height: ","px;\n position: absolute;\n top: 40%;\n left: 0;\n z-index: -1;\n overflow: hidden;\n ",";\n"],["\n width: 100%;\n height: ","px;\n position: absolute;\n top: 40%;\n left: 0;\n z-index: -1;\n overflow: hidden;\n ",";\n"])),function(i){return i.height},s.media.large(m||(m=k(["\n top: 100%;\n transform: translateY(-50%);\n "],["\n top: 100%;\n transform: translateY(-50%);\n "])))),d=p.default.div(h||(h=k(["\n position: absolute;\n top: 0;\n left: 50%;\n transform: translateX(-50%);\n"],["\n position: absolute;\n top: 0;\n left: 50%;\n transform: translateX(-50%);\n"])))}}]); +//# sourceMappingURL=bundle-compiler-animation.350d539fdb811c75be5d.js.map \ No newline at end of file diff --git a/packages/dev-tools-pages/public/bundle-compiler-animation.350d539fdb811c75be5d.js.map b/packages/dev-tools-pages/public/bundle-compiler-animation.350d539fdb811c75be5d.js.map new file mode 100644 index 0000000000..206387a34f --- /dev/null +++ b/packages/dev-tools-pages/public/bundle-compiler-animation.350d539fdb811c75be5d.js.map @@ -0,0 +1 @@ +{"version":3,"sources":["webpack:///./ts/components/animations/compiler/index.tsx","webpack:///./ts/components/animations/index.tsx"],"names":["React","__webpack_require__","index_1","animationData","exports","CompilerAnimation","createElement","BaseAnimation","width","height","react_lottie_1","styled_components_1","variables_1","_super","_this","apply","this","arguments","state","undefined","_timeout","__extends","prototype","componentDidMount","_updateAnimationSize","window","addEventListener","_handleResize","bind","componentWillUnmount","removeEventListener","render","props","Container","InnerContainer","default","options","loop","autoplay","clearTimeout","setTimeout","windowWidth","innerWidth","ratio","Math","round","setState","PureComponent","div","templateObject_2","__makeTemplateObject","media","large","templateObject_1","templateObject_3"],"mappings":"mi2CAAA,IAAAA,EAAAC,EAAA,GAEAC,EAAAD,EAAA,IAEAE,EAAAF,EAAA,KAMSG,EAAAC,kBAJ+C,WAAM,OAC1DL,EAAAM,cAACJ,EAAAK,cAAa,CAACJ,cAAeA,EAAeK,MAAO,KAAMC,OAAQ,2iBCPtE,IAAAT,EAAAC,EAAA,GACAS,EAAAT,EAAA,IACAU,EAAAV,EAAA,GAEAW,EAAAX,EAAA,GAaAM,EAAA,SAAAM,GAAA,SAAAN,IAAA,IAAAO,EAAA,OAAAD,KAAAE,MAAAC,KAAAC,YAAAD,YACWF,EAAAI,MAAwB,CAC3BT,YAAQU,EACRX,WAAOW,GAEHL,EAAAM,cAAWD,IA+CvB,OApD4BE,EAAAd,EAAAM,GAMjBN,EAAAe,UAAAC,kBAAP,WACIP,KAAKQ,uBACLC,OAAOC,iBAAiB,SAAUV,KAAKW,cAAcC,KAAKZ,QAEvDT,EAAAe,UAAAO,qBAAP,WACIJ,OAAOK,oBAAoB,SAAUd,KAAKW,cAAcC,KAAKZ,QAE1DT,EAAAe,UAAAS,OAAP,WACY,IAAA5B,EAAAa,KAAAgB,MAAA7B,cACFM,EAASO,KAAKE,MAAMT,QAAUO,KAAKgB,MAAMvB,OACzCD,EAAQQ,KAAKE,MAAMV,OAASQ,KAAKgB,MAAMxB,MAE7C,OACIR,EAAAM,cAAC2B,EAAS,CAACxB,OAAQA,GACfT,EAAAM,cAAC4B,EAAc,KACXlC,EAAAM,cAACI,EAAAyB,QAAM,CACH3B,MAAOA,EACPC,OAAQA,EACR2B,QAAS,CACLC,MAAM,EACNC,UAAU,EACVnC,cAAaA,QAO7BI,EAAAe,UAAAK,cAAR,WACIY,aAAavB,KAAKI,UAClBJ,KAAKI,SAAWK,OAAOe,WAAWxB,KAAKQ,qBAAqBI,KAAKZ,MAAO,KAEpET,EAAAe,UAAAE,qBAAR,WACI,IACIhB,EACAC,EAFEgC,EAAchB,OAAOiB,WAG3B,GAAID,GAAe,IAAM,CACrB,IACME,GADWF,EAAc,KACNzB,KAAKgB,MAAMxB,MAEpCC,EAASmC,KAAKC,MAAM7B,KAAKgB,MAAMvB,OAASkC,GACxCnC,EAAQoC,KAAKC,MAAM7B,KAAKgB,MAAMxB,MAAQmC,GAG1C3B,KAAK8B,SAAS,CAAEtC,MAAKA,EAAEC,OAAMA,KAErCF,EApDA,CAA4BP,EAAM+C,eA2EzB3C,EAAAG,gBArBT,UAAM0B,EAAYtB,EAAAwB,QAAOa,IAAGC,MAAAC,EAAA,uJAAgB,mCAET,2GAS9B,SATS,SAAAlB,GAAS,OAAAA,EAAMvB,QAMvBG,EAAAuC,MAAMC,MAAKC,MAAAH,EAAA,8IAMXhB,EAAiBvB,EAAAwB,QAAOa,IAAGM,MAAAJ,EAAA","file":"bundle-compiler-animation.350d539fdb811c75be5d.js","sourcesContent":["import * as React from 'react';\n\nimport { BaseAnimation } from '../index';\n\nimport * as animationData from './data.json';\n\nconst CompilerAnimation: React.StatelessComponent<{}> = () => (\n \n);\n\nexport { CompilerAnimation };\n","import * as React from 'react';\nimport Lottie from 'react-lottie';\nimport styled from 'styled-components';\n\nimport { media } from 'ts/variables';\n\ninterface AnimationProps {\n animationData: object;\n width: number;\n height: number;\n}\n\ninterface AnimationState {\n width?: number | undefined;\n height?: number | undefined;\n}\n\nclass BaseAnimation extends React.PureComponent {\n public state: AnimationState = {\n height: undefined,\n width: undefined,\n };\n private _timeout = undefined as number;\n public componentDidMount(): void {\n this._updateAnimationSize();\n window.addEventListener('resize', this._handleResize.bind(this));\n }\n public componentWillUnmount(): void {\n window.removeEventListener('resize', this._handleResize.bind(this));\n }\n public render(): React.ReactNode {\n const { animationData } = this.props;\n const height = this.state.height || this.props.height;\n const width = this.state.width || this.props.width;\n\n return (\n \n \n \n \n \n );\n }\n private _handleResize(): void {\n clearTimeout(this._timeout);\n this._timeout = window.setTimeout(this._updateAnimationSize.bind(this), 50);\n }\n private _updateAnimationSize(): void {\n const windowWidth = window.innerWidth;\n let width;\n let height;\n if (windowWidth <= 1000) {\n const maxWidth = windowWidth + 250;\n const ratio = maxWidth / this.props.width;\n\n height = Math.round(this.props.height * ratio);\n width = Math.round(this.props.width * ratio);\n }\n\n this.setState({ width, height });\n }\n}\n\nconst Container = styled.div`\n width: 100%;\n height: ${props => props.height}px;\n position: absolute;\n top: 40%;\n left: 0;\n z-index: -1;\n overflow: hidden;\n ${media.large`\n top: 100%;\n transform: translateY(-50%);\n `};\n`;\n\nconst InnerContainer = styled.div`\n position: absolute;\n top: 0;\n left: 50%;\n transform: translateX(-50%);\n`;\n\nexport { BaseAnimation };\n"],"sourceRoot":""} \ No newline at end of file diff --git a/packages/dev-tools-pages/public/bundle-compiler.e7d3a5bb143e462b27d6.js b/packages/dev-tools-pages/public/bundle-compiler.e7d3a5bb143e462b27d6.js new file mode 100644 index 0000000000..1fe3f191c7 --- /dev/null +++ b/packages/dev-tools-pages/public/bundle-compiler.e7d3a5bb143e462b27d6.js @@ -0,0 +1,47 @@ +!function(e){function t(t){for(var n,o,i=t[0],a=t[1],u=0,c=[];u=0||Object.prototype.hasOwnProperty.call(e,r)&&(n[r]=e[r]);return n},_=function(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t},k=function(e){return"object"===(void 0===e?"undefined":m(e))&&e.constructor===Object},x=Object.freeze([]),C=Object.freeze({});function E(e){return"function"==typeof e}function S(e){return e.displayName||e.name||"Component"}function T(e){return e&&"string"==typeof e.styledComponentId}var O=void 0!==e&&Object({NODE_ENV:"production"}).SC_ATTR||"data-styled",j="undefined"!=typeof window&&"HTMLElement"in window,P="boolean"==typeof SC_DISABLE_SPEEDY&&SC_DISABLE_SPEEDY||!1,A={};var I=function(e){function t(n){v(this,t);for(var r=arguments.length,o=Array(r>1?r-1:0),i=1;i0&&-1!==n.slice(0,t).indexOf(W)&&n.slice(t-W.length,t)!==W?"."+B:e};F.use([function(e,t,n){2===e&&n.length&&n[0].lastIndexOf(W)>0&&(n[0]=n[0].replace($,H))},U,D]),z.use([U,D]);function V(e,t,n){var r=arguments.length>3&&void 0!==arguments[3]?arguments[3]:"&",o=e.join("").replace(R,""),i=t&&n?n+" "+t+" { "+o+" }":o;return B=r,W=t,$=new RegExp("\\"+W+"\\b","g"),F(n||!t?"":t,i)}var q=function(){return n.nc},G=function(e,t,n){n&&((e[t]||(e[t]=Object.create(null)))[n]=!0)},K=function(e,t){e[t]=Object.create(null)},Y=function(e){return function(t,n){return void 0!==e[t]&&e[t][n]}},Q=function(e){var t="";for(var n in e)t+=Object.keys(e[n]).join(" ")+" ";return t.trim()},X=function(e){if(e.sheet)return e.sheet;for(var t=document.styleSheets.length,n=0;n"+e()+""}},ne=function(e,t){return function(){var n,r=((n={})[O]=Q(t),n["data-styled-version"]="4.1.1",n),o=q();return o&&(r.nonce=o),c.a.createElement("style",y({},r,{dangerouslySetInnerHTML:{__html:e()}}))}},re=function(e){return function(){return Object.keys(e)}},oe=function(e){return document.createTextNode(J(e))},ie=function e(t,n){var r=void 0===t?Object.create(null):t,o=void 0===n?Object.create(null):n,i=function(e){var t=o[e];return void 0!==t?t:o[e]=[""]},a=function(){var e="";for(var t in o){var n=o[t][0];n&&(e+=J(t)+n)}return e};return{clone:function(){var t=function(e){var t=Object.create(null);for(var n in e)t[n]=y({},e[n]);return t}(r),n=Object.create(null);for(var i in o)n[i]=[o[i][0]];return e(t,n)},css:a,getIds:re(o),hasNameForId:Y(r),insertMarker:i,insertRules:function(e,t,n){i(e)[0]+=t.join(" "),G(r,e,n)},removeRules:function(e){var t=o[e];void 0!==t&&(t[0]="",K(r,e))},sealed:!1,styleTag:null,toElement:ne(a,r),toHTML:te(a,r)}},ae=function(e,t,n,r,o){if(j&&!n){var i=function(e,t,n){var r=document.createElement("style");r.setAttribute(O,""),r.setAttribute("data-styled-version","4.1.1");var o=q();if(o&&r.setAttribute("nonce",o),r.appendChild(document.createTextNode("")),e&&!t)e.appendChild(r);else{if(!t||!e||!t.parentNode)throw new I(6);t.parentNode.insertBefore(r,n?t:t.nextSibling)}return r}(e,t,r);return P?function(e,t){var n=Object.create(null),r=Object.create(null),o=void 0!==t,i=!1,a=function(t){var o=r[t];return void 0!==o?o:(r[t]=oe(t),e.appendChild(r[t]),n[t]=Object.create(null),r[t])},u=function(){var e="";for(var t in r)e+=r[t].data;return e};return{clone:function(){throw new I(5)},css:u,getIds:re(r),hasNameForId:Y(n),insertMarker:a,insertRules:function(e,r,u){for(var l=a(e),c=[],s=r.length,f=0;f0&&(i=!0,t().insertRules(e+"-import",c))},removeRules:function(a){var u=r[a];if(void 0!==u){var l=oe(a);e.replaceChild(l,u),r[a]=l,K(n,a),o&&i&&t().removeRules(a+"-import")}},sealed:!1,styleTag:e,toElement:ne(u,n),toHTML:te(u,n)}}(i,o):function(e,t){var n=Object.create(null),r=Object.create(null),o=[],i=void 0!==t,a=!1,u=function(e){var t=r[e];return void 0!==t?t:(r[e]=o.length,o.push(0),K(n,e),r[e])},l=function(){var t=X(e).cssRules,n="";for(var i in r){n+=J(i);for(var a=r[i],u=ee(o,a),l=u-o[a];l0&&(a=!0,t().insertRules(r+"-import",h)),o[s]+=p,G(n,r,c)},removeRules:function(u){var l=r[u];if(void 0!==l){var c=o[l];!function(e,t,n){for(var r=t-n,o=t;o>r;o-=1)e.deleteRule(o)}(X(e),ee(o,l)-1,c),o[l]=0,K(n,u),i&&a&&t().removeRules(u+"-import")}},sealed:!1,styleTag:e,toElement:ne(l,n),toHTML:te(l,n)}}(i,o)}return ie()},ue=/\s+/,le=void 0;le=j?P?40:1e3:-1;var ce=0,se=void 0,fe=function(){function e(){var t=this,n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:j?document.head:null,r=arguments.length>1&&void 0!==arguments[1]&&arguments[1];v(this,e),this.getImportRuleTag=function(){var e=t.importRuleTag;if(void 0!==e)return e;var n=t.tags[0];return t.importRuleTag=ae(t.target,n?n.styleTag:null,t.forceServer,!0)},ce+=1,this.id=ce,this.forceServer=r,this.target=r?null:n,this.tagMap={},this.deferred={},this.rehydratedNames={},this.ignoreRehydratedNames={},this.tags=[],this.capacity=1,this.clones=[]}return e.prototype.rehydrate=function(){if(!j||this.forceServer)return this;var e=[],t=[],n=!1,r=document.querySelectorAll("style["+O+'][data-styled-version="4.1.1"]'),o=r.length;if(!o)return this;for(var i=0;i0&&void 0!==arguments[0]&&arguments[0];se=new e(void 0,t).rehydrate()},e.prototype.clone=function(){var t=new e(this.target,this.forceServer);return this.clones.push(t),t.tags=this.tags.map(function(e){for(var n=e.getIds(),r=e.clone(),o=0;o1?t-1:0),r=1;r=4;)t=1540483477*(65535&(t=255&e.charCodeAt(o)|(255&e.charCodeAt(++o))<<8|(255&e.charCodeAt(++o))<<16|(255&e.charCodeAt(++o))<<24))+((1540483477*(t>>>16)&65535)<<16),r=1540483477*(65535&r)+((1540483477*(r>>>16)&65535)<<16)^(t=1540483477*(65535&(t^=t>>>24))+((1540483477*(t>>>16)&65535)<<16)),n-=4,++o;switch(n){case 3:r^=(255&e.charCodeAt(o+2))<<16;case 2:r^=(255&e.charCodeAt(o+1))<<8;case 1:r=1540483477*(65535&(r^=255&e.charCodeAt(o)))+((1540483477*(r>>>16)&65535)<<16)}return((r=1540483477*(65535&(r^=r>>>13))+((1540483477*(r>>>16)&65535)<<16))^r>>>15)>>>0}var we=52,_e=function(e){return String.fromCharCode(e+(e>25?39:97))};function ke(e){var t="",n=void 0;for(n=e;n>we;n=Math.floor(n/we))t=_e(n%we)+t;return _e(n%we)+t}function xe(e,t){for(var n=0;n2&&void 0!==arguments[2]?arguments[2]:C,r=!!n&&e.theme===n.theme;return e.theme&&!r?e.theme:t||n.theme},je=/[[\].#*$><+~=|^:(),"'`-]+/g,Pe=/(^-|-$)/g;function Ae(e){return e.replace(je,"-").replace(Pe,"")}function Ie(e){return"string"==typeof e}var Ne={childContextTypes:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDerivedStateFromProps:!0,propTypes:!0,type:!0},Me={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},Re=((Ce={})[f.ForwardRef]={$$typeof:!0,render:!0},Ce),ze=Object.defineProperty,Fe=Object.getOwnPropertyNames,Le=Object.getOwnPropertySymbols,De=void 0===Le?function(){return[]}:Le,Ue=Object.getOwnPropertyDescriptor,Be=Object.getPrototypeOf,We=Object.prototype,$e=Array.prototype;function He(e,t,n){if("string"!=typeof t){var r=Be(t);r&&r!==We&&He(e,r,n);for(var o=$e.concat(Fe(t),De(t)),i=Re[e.$$typeof]||Ne,a=Re[t.$$typeof]||Ne,u=o.length,l=void 0,c=void 0;u--;)if(c=o[u],!(Me[c]||n&&n[c]||a&&a[c]||i&&i[c])&&(l=Ue(t,c)))try{ze(e,c,l)}catch(e){}return e}return e}var Ve=function(e){var t=!1;return function(){t||(t=!0,e.apply(void 0,arguments))}},qe=Object(l.createContext)(),Ge=qe.Consumer,Ke=function(e){function t(n){v(this,t);var r=_(this,e.call(this,n));return r.getContext=Object(d.a)(r.getContext.bind(r)),r.renderInner=r.renderInner.bind(r),r}return b(t,e),t.prototype.render=function(){return this.props.children?c.a.createElement(qe.Consumer,null,this.renderInner):null},t.prototype.renderInner=function(e){var t=this.getContext(this.props.theme,e);return c.a.createElement(qe.Provider,{value:t},c.a.Children.only(this.props.children))},t.prototype.getTheme=function(e,t){if(E(e))return e(t);if(null===e||Array.isArray(e)||"object"!==(void 0===e?"undefined":m(e)))throw new I(8);return y({},t,e)},t.prototype.getContext=function(e,t){return this.getTheme(e,t)},t}(l.Component),Ye=function(){function e(){v(this,e),this.masterSheet=fe.master,this.instance=this.masterSheet.clone(),this.sealed=!1}return e.prototype.seal=function(){if(!this.sealed){var e=this.masterSheet.clones.indexOf(this.instance);this.masterSheet.clones.splice(e,1),this.sealed=!0}},e.prototype.collectStyles=function(e){if(this.sealed)throw new I(2);return c.a.createElement(Ze,{sheet:this.instance},e)},e.prototype.getStyleTags=function(){return this.seal(),this.instance.toHTML()},e.prototype.getStyleElement=function(){return this.seal(),this.instance.toReactElements()},e.prototype.interleaveWithNodeStream=function(e){throw new I(3)},e}(),Qe=Object(l.createContext)(),Xe=Qe.Consumer,Ze=function(e){function t(n){v(this,t);var r=_(this,e.call(this,n));return r.getContext=Object(d.a)(r.getContext),r}return b(t,e),t.prototype.getContext=function(e,t){if(e)return e;if(t)return new fe(t);throw new I(4)},t.prototype.render=function(){var e=this.props,t=e.children,n=e.sheet,r=e.target;return c.a.createElement(Qe.Provider,{value:this.getContext(n,r)},t)},t}(l.Component),Je=(new Set,{});Ve(function(){return console.warn('The "innerRef" API has been removed in styled-components v4 in favor of React 16 ref forwarding, use "ref" instead like a typical component.')}),Ve(function(e,t){return console.warn('Functions as object-form attrs({}) keys are now deprecated and will be removed in a future version of styled-components. Switch to the new attrs(props => ({})) syntax instead for easier and more powerful composition. The attrs key in question is "'+e+'" on component "'+t+'".')}),Ve(function(e,t){return console.warn("It looks like you've used a non styled-component as the value for the \""+e+'" prop in an object-form attrs constructor of "'+t+"\".\nYou should use the new function-form attrs constructor which avoids this issue: attrs(props => ({ yourStuff }))\nTo continue using the deprecated object syntax, you'll need to wrap your component prop in a function to make it available inside the styled component (you'll still get the deprecation warning though.)\nFor example, { "+e+": () => InnerComponent } instead of { "+e+": InnerComponent }")});var et=function(e){function t(){v(this,t);var n=_(this,e.call(this));return n.attrs={},n.renderOuter=n.renderOuter.bind(n),n.renderInner=n.renderInner.bind(n),n}return b(t,e),t.prototype.render=function(){return c.a.createElement(Xe,null,this.renderOuter)},t.prototype.renderOuter=function(e){return this.styleSheet=e,this.props.forwardedClass.componentStyle.isStatic?this.renderInner():c.a.createElement(Ge,null,this.renderInner)},t.prototype.renderInner=function(e){var t=this.props.forwardedClass,n=t.componentStyle,r=t.defaultProps,o=t.styledComponentId,i=t.target,a=void 0;a=n.isStatic?this.generateAndInjectStyles(C,this.props,this.styleSheet):void 0!==e?this.generateAndInjectStyles(Oe(this.props,e,r),this.props,this.styleSheet):this.generateAndInjectStyles(this.props.theme||C,this.props,this.styleSheet);var u=this.props.as||this.attrs.as||i,c=Ie(u),s={},f=y({},this.attrs,this.props),d=void 0;for(d in f)"forwardedClass"!==d&&"as"!==d&&("forwardedRef"===d?s.ref=f[d]:c&&!Object(p.a)(d)||(s[d]=f[d]));return this.props.style&&this.attrs.style&&(s.style=y({},this.attrs.style,this.props.style)),s.className=[this.props.className,o,this.attrs.className,a].filter(Boolean).join(" "),Object(l.createElement)(u,s)},t.prototype.buildExecutionContext=function(e,t,n){var r=this,o=y({},t,{theme:e});return n.length?(this.attrs={},n.forEach(function(e){var n,i=e,a=!1,u=void 0,l=void 0;for(l in E(i)&&(i=i(t),a=!0),i)u=i[l],a||!E(u)||(n=u)&&n.prototype&&n.prototype.isReactComponent||T(u)||(u=u(o)),r.attrs[l]=u,o[l]=u}),o):o},t.prototype.generateAndInjectStyles=function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:fe.master,r=t.forwardedClass,o=r.attrs,i=r.componentStyle;r.warnTooManyClasses;return i.isStatic&&!o.length?i.generateAndInjectStyles(C,n):i.generateAndInjectStyles(this.buildExecutionContext(e,t,o),n)},t}(l.Component);function tt(e,t,n){var r=T(e),o=!Ie(e),i=t.displayName,a=void 0===i?function(e){return Ie(e)?"styled."+e:"Styled("+S(e)+")"}(e):i,u=t.componentId,l=void 0===u?function(e,t,n){var r="string"!=typeof t?"sc":Ae(t),o=(Je[r]||0)+1;Je[r]=o;var i=r+"-"+e.generateName(r+o);return n?n+"-"+i:i}(Te,t.displayName,t.parentComponentId):u,s=t.ParentComponent,f=void 0===s?et:s,d=t.attrs,p=void 0===d?x:d,h=t.displayName&&t.componentId?Ae(t.displayName)+"-"+t.componentId:t.componentId||l,m=r&&e.attrs?Array.prototype.concat(e.attrs,p).filter(Boolean):p,v=new Te(r?e.componentStyle.rules.concat(n):n,m,h),g=c.a.forwardRef(function(e,t){return c.a.createElement(f,y({},e,{forwardedClass:g,forwardedRef:t}))});return g.attrs=m,g.componentStyle=v,g.displayName=a,g.styledComponentId=h,g.target=r?e.target:e,g.withComponent=function(e){var r=t.componentId,o=w(t,["componentId"]),i=r&&r+"-"+(Ie(e)?e:Ae(S(e)));return tt(e,y({},o,{attrs:m,componentId:i,ParentComponent:f}),n)},g.toString=function(){return"."+g.styledComponentId},o&&He(g,e,{attrs:!0,componentStyle:!0,displayName:!0,styledComponentId:!0,target:!0,withComponent:!0}),g}var nt=function(e){return function e(t,n){var r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:C;if(!Object(f.isValidElementType)(n))throw new I(1,String(n));var o=function(){return t(n,r,ye.apply(void 0,arguments))};return o.withConfig=function(o){return e(t,n,y({},r,o))},o.attrs=function(o){return e(t,n,y({},r,{attrs:Array.prototype.concat(r.attrs,o).filter(Boolean)}))},o}(tt,e)};["a","abbr","address","area","article","aside","audio","b","base","bdi","bdo","big","blockquote","body","br","button","canvas","caption","cite","code","col","colgroup","data","datalist","dd","del","details","dfn","dialog","div","dl","dt","em","embed","fieldset","figcaption","figure","footer","form","h1","h2","h3","h4","h5","h6","head","header","hgroup","hr","html","i","iframe","img","input","ins","kbd","keygen","label","legend","li","link","main","map","mark","marquee","menu","menuitem","meta","meter","nav","noscript","object","ol","optgroup","option","output","p","param","picture","pre","progress","q","rp","rt","ruby","s","samp","script","section","select","small","source","span","strong","style","sub","summary","sup","table","tbody","td","textarea","tfoot","th","thead","time","title","tr","track","u","ul","var","video","wbr","circle","clipPath","defs","ellipse","foreignObject","g","image","line","linearGradient","mask","path","pattern","polygon","polyline","radialGradient","rect","stop","svg","text","tspan"].forEach(function(e){nt[e]=nt(e)});var rt=function(){function e(t,n){v(this,e),this.rules=t,this.componentId=n,this.isStatic=xe(t,x),fe.master.hasId(n)||fe.master.deferredInject(n,[])}return e.prototype.createStyles=function(e,t){var n=V(ge(this.rules,e,t),"");t.inject(this.componentId,n)},e.prototype.removeStyles=function(e){var t=this.componentId;e.hasId(t)&&e.remove(t)},e.prototype.renderStyles=function(e,t){this.removeStyles(t),this.createStyles(e,t)},e}();function ot(e){for(var t=arguments.length,n=Array(t>1?t-1:0),r=1;r1?t-1:0),r=1;r])/g,y=/([[}=:>])\s+/g,b=/(\{[^{]+?);(?=\})/g,w=/\s{2,}/g,_=/([^\(])(:+) */g,k=/[svh]\w+-[tblr]{2}/,x=/\(\s*(.*)\s*\)/g,C=/([\s\S]*?);/g,E=/-self|flex-/g,S=/[^]*?(:[rp][el]a[\w-]+)[^]*/,T=/stretch|:\s*\w+\-(?:conte|avail)/,O="-webkit-",j="-moz-",P="-ms-",A=59,I=125,N=123,M=40,R=41,z=91,F=93,L=10,D=13,U=9,B=64,W=32,$=38,H=45,V=95,q=42,G=44,K=58,Y=39,Q=34,X=47,Z=62,J=43,ee=126,te=0,ne=12,re=11,oe=107,ie=109,ae=115,ue=112,le=111,ce=169,se=163,fe=100,de=112,pe=1,he=1,me=0,ve=1,ge=1,ye=1,be=0,we=0,_e=0,ke=[],xe=[],Ce=0,Ee=null,Se=-2,Te=-1,Oe=0,je=1,Pe=2,Ae=3,Ie=0,Ne=1,Me="",Re="",ze="";function Fe(e,t,o,i,a){for(var u,l,s=0,f=0,d=0,p=0,g=0,y=0,b=0,w=0,k=0,C=0,E=0,S=0,T=0,V=0,be=0,xe=0,Ee=0,Se=0,Te=0,De=o.length,He=De-1,Ve="",qe="",Ge="",Ke="",Ye="",Qe="";be0&&(qe=qe.replace(r,"")),qe.trim().length>0)){switch(b){case W:case U:case A:case D:case L:break;default:qe+=o.charAt(be)}b=A}if(1===Ee)switch(b){case N:case I:case A:case Q:case Y:case M:case R:case G:Ee=0;case U:case D:case L:case W:break;default:for(Ee=0,Te=be,g=b,be--,b=A;Te0&&(++be,b=g);case N:Te=De}}switch(b){case N:for(g=(qe=qe.trim()).charCodeAt(0),E=1,Te=++be;be0&&(qe=qe.replace(r,"")),y=qe.charCodeAt(1)){case fe:case ie:case ae:case H:u=t;break;default:u=ke}if(Te=(Ge=Fe(t,u,Ge,y,a+1)).length,_e>0&&0===Te&&(Te=qe.length),Ce>0&&(u=Le(ke,qe,Se),l=$e(Ae,Ge,u,t,he,pe,Te,y,a,i),qe=u.join(""),void 0!==l&&0===(Te=(Ge=l.trim()).length)&&(y=0,Ge="")),Te>0)switch(y){case ae:qe=qe.replace(x,We);case fe:case ie:case H:Ge=qe+"{"+Ge+"}";break;case oe:Ge=(qe=qe.replace(h,"$1 $2"+(Ne>0?Me:"")))+"{"+Ge+"}",Ge=1===ge||2===ge&&Be("@"+Ge,3)?"@"+O+Ge+"@"+Ge:"@"+Ge;break;default:Ge=qe+Ge,i===de&&(Ke+=Ge,Ge="")}else Ge="";break;default:Ge=Fe(t,Le(t,qe,Se),Ge,i,a+1)}Ye+=Ge,S=0,Ee=0,V=0,xe=0,Se=0,T=0,qe="",Ge="",b=o.charCodeAt(++be);break;case I:case A:if((Te=(qe=(xe>0?qe.replace(r,""):qe).trim()).length)>1)switch(0===V&&((g=qe.charCodeAt(0))===H||g>96&&g<123)&&(Te=(qe=qe.replace(" ",":")).length),Ce>0&&void 0!==(l=$e(je,qe,t,e,he,pe,Ke.length,i,a,i))&&0===(Te=(qe=l.trim()).length)&&(qe="\0\0"),(g=qe.charCodeAt(0))+(y=qe.charCodeAt(1))){case te:break;case ce:case se:Qe+=qe+o.charAt(be);break;default:if(qe.charCodeAt(Te-1)===K)break;Ke+=Ue(qe,g,y,qe.charCodeAt(2))}S=0,Ee=0,V=0,xe=0,Se=0,qe="",b=o.charCodeAt(++be)}}switch(b){case D:case L:if(f+p+d+s+we===0)switch(C){case R:case Y:case Q:case B:case ee:case Z:case q:case J:case X:case H:case K:case G:case A:case N:case I:break;default:V>0&&(Ee=1)}f===X?f=0:ve+S===0&&(xe=1,qe+="\0"),Ce*Ie>0&&$e(Oe,qe,t,e,he,pe,Ke.length,i,a,i),pe=1,he++;break;case A:case I:if(f+p+d+s===0){pe++;break}default:switch(pe++,Ve=o.charAt(be),b){case U:case W:if(p+s+f===0)switch(w){case G:case K:case U:case W:Ve="";break;default:b!==W&&(Ve=" ")}break;case te:Ve="\\0";break;case ne:Ve="\\f";break;case re:Ve="\\v";break;case $:p+f+s===0&&ve>0&&(Se=1,xe=1,Ve="\f"+Ve);break;case 108:if(p+f+s+me===0&&V>0)switch(be-V){case 2:w===ue&&o.charCodeAt(be-3)===K&&(me=w);case 8:k===le&&(me=k)}break;case K:p+f+s===0&&(V=be);break;case G:f+d+p+s===0&&(xe=1,Ve+="\r");break;case Q:case Y:0===f&&(p=p===b?0:0===p?b:p);break;case z:p+f+d===0&&s++;break;case F:p+f+d===0&&s--;break;case R:p+f+s===0&&d--;break;case M:if(p+f+s===0){if(0===S)switch(2*w+3*k){case 533:break;default:E=0,S=1}d++}break;case B:f+d+p+s+V+T===0&&(T=1);break;case q:case X:if(p+s+d>0)break;switch(f){case 0:switch(2*b+3*o.charCodeAt(be+1)){case 235:f=X;break;case 220:Te=be,f=q}break;case q:b===X&&w===q&&(33===o.charCodeAt(Te+2)&&(Ke+=o.substring(Te,be+1)),Ve="",f=0)}}if(0===f){if(ve+p+s+T===0&&i!==oe&&b!==A)switch(b){case G:case ee:case Z:case J:case R:case M:if(0===S){switch(w){case U:case W:case L:case D:Ve+="\0";break;default:Ve="\0"+Ve+(b===G?"":"\0")}xe=1}else switch(b){case M:S=++E;break;case R:0==(S=--E)&&(xe=1,Ve+="\0")}break;case U:case W:switch(w){case te:case N:case I:case A:case G:case ne:case U:case W:case L:case D:break;default:0===S&&(xe=1,Ve+="\0")}}qe+=Ve,b!==W&&b!==U&&(C=b)}}k=w,w=b,be++}if(Te=Ke.length,_e>0&&0===Te&&0===Ye.length&&0===t[0].length==0&&(i!==ie||1===t.length&&(ve>0?Re:ze)===t[0])&&(Te=t.join(",").length+2),Te>0){if(u=0===ve&&i!==oe?function(e){for(var t,n,o=0,i=e.length,a=Array(i);o1)){if(d=l.charCodeAt(l.length-1),p=n.charCodeAt(0),t="",0!==s)switch(d){case q:case ee:case Z:case J:case W:case M:break;default:t=" "}switch(p){case $:n=t+Re;case ee:case Z:case J:case W:case R:case M:break;case z:n=t+n+Re;break;case K:switch(2*n.charCodeAt(1)+3*n.charCodeAt(2)){case 530:if(ye>0){n=t+n.substring(8,f-1);break}default:(s<1||u[s-1].length<1)&&(n=t+Re+n)}break;case G:t="";default:n=f>1&&n.indexOf(":")>0?t+n.replace(_,"$1"+Re+"$2"):t+n+Re}l+=n}a[o]=l.replace(r,"").trim()}return a}(t):t,Ce>0&&void 0!==(l=$e(Pe,Ke,u,e,he,pe,Te,i,a,i))&&0===(Ke=l).length)return Qe+Ke+Ye;if(Ke=u.join(",")+"{"+Ke+"}",ge*me!=0){switch(2!==ge||Be(Ke,2)||(me=0),me){case le:Ke=Ke.replace(v,":"+j+"$1")+Ke;break;case ue:Ke=Ke.replace(m,"::"+O+"input-$1")+Ke.replace(m,"::"+j+"$1")+Ke.replace(m,":"+P+"input-$1")+Ke}me=0}}return Qe+Ke+Ye}function Le(e,t,n){var r=t.trim().split(s),o=r,i=r.length,a=e.length;switch(a){case 0:case 1:for(var u=0,l=0===a?"":e[0]+" ";u0&&ve>0)return o.replace(d,"$1").replace(f,"$1"+ze);break;default:return e.trim()+o.replace(f,"$1"+e.trim())}default:if(n*ve>0&&o.indexOf("\f")>0)return o.replace(f,(e.charCodeAt(0)===K?"":"$1")+e.trim())}return e+o}function Ue(e,t,n,r){var c,s=0,f=e+";",d=2*t+3*n+4*r;if(944===d)return function(e){var t=e.length,n=e.indexOf(":",9)+1,r=e.substring(0,n).trim(),o=e.substring(n,t-1).trim();switch(e.charCodeAt(9)*Ne){case 0:break;case H:if(110!==e.charCodeAt(10))break;default:for(var i=o.split((o="",u)),a=0,n=0,t=i.length;aB&&f<90||f>96&&f<123||f===V||f===H&&c.charCodeAt(1)!==H))switch(isNaN(parseFloat(c))+(-1!==c.indexOf("("))){case 1:switch(c){case"infinite":case"alternate":case"backwards":case"running":case"normal":case"forwards":case"both":case"none":case"linear":case"ease":case"ease-in":case"ease-out":case"ease-in-out":case"paused":case"reverse":case"alternate-reverse":case"inherit":case"initial":case"unset":case"step-start":case"step-end":break;default:c+=Me}}s[n++]=c}o+=(0===a?"":",")+s.join(" ")}}return o=r+o+";",1===ge||2===ge&&Be(o,1)?O+o+o:o}(f);if(0===ge||2===ge&&!Be(f,1))return f;switch(d){case 1015:return 97===f.charCodeAt(10)?O+f+f:f;case 951:return 116===f.charCodeAt(3)?O+f+f:f;case 963:return 110===f.charCodeAt(5)?O+f+f:f;case 1009:if(100!==f.charCodeAt(4))break;case 969:case 942:return O+f+f;case 978:return O+f+j+f+f;case 1019:case 983:return O+f+j+f+P+f+f;case 883:return f.charCodeAt(8)===H?O+f+f:f;case 932:if(f.charCodeAt(4)===H)switch(f.charCodeAt(5)){case 103:return O+"box-"+f.replace("-grow","")+O+f+P+f.replace("grow","positive")+f;case 115:return O+f+P+f.replace("shrink","negative")+f;case 98:return O+f+P+f.replace("basis","preferred-size")+f}return O+f+P+f+f;case 964:return O+f+P+"flex-"+f+f;case 1023:if(99!==f.charCodeAt(8))break;return c=f.substring(f.indexOf(":",15)).replace("flex-","").replace("space-between","justify"),O+"box-pack"+c+O+f+P+"flex-pack"+c+f;case 1005:return i.test(f)?f.replace(o,":"+O)+f.replace(o,":"+j)+f:f;case 1e3:switch(s=(c=f.substring(13).trim()).indexOf("-")+1,c.charCodeAt(0)+c.charCodeAt(s)){case 226:c=f.replace(k,"tb");break;case 232:c=f.replace(k,"tb-rl");break;case 220:c=f.replace(k,"lr");break;default:return f}return O+f+P+c+f;case 1017:if(-1===f.indexOf("sticky",9))return f;case 975:switch(s=(f=e).length-10,d=(c=(33===f.charCodeAt(s)?f.substring(0,s):f).substring(e.indexOf(":",7)+1).trim()).charCodeAt(0)+(0|c.charCodeAt(7))){case 203:if(c.charCodeAt(8)<111)break;case 115:f=f.replace(c,O+c)+";"+f;break;case 207:case 102:f=f.replace(c,O+(d>102?"inline-":"")+"box")+";"+f.replace(c,O+c)+";"+f.replace(c,P+c+"box")+";"+f}return f+";";case 938:if(f.charCodeAt(5)===H)switch(f.charCodeAt(6)){case 105:return c=f.replace("-items",""),O+f+O+"box-"+c+P+"flex-"+c+f;case 115:return O+f+P+"flex-item-"+f.replace(E,"")+f;default:return O+f+P+"flex-line-pack"+f.replace("align-content","").replace(E,"")+f}break;case 973:case 989:if(f.charCodeAt(3)!==H||122===f.charCodeAt(4))break;case 931:case 953:if(!0===T.test(e))return 115===(c=e.substring(e.indexOf(":")+1)).charCodeAt(0)?Ue(e.replace("stretch","fill-available"),t,n,r).replace(":fill-available",":stretch"):f.replace(c,O+c)+f.replace(c,j+c.replace("fill-",""))+f;break;case 962:if(f=O+f+(102===f.charCodeAt(5)?P+f:"")+f,n+r===211&&105===f.charCodeAt(13)&&f.indexOf("transform",10)>0)return f.substring(0,f.indexOf(";",27)+1).replace(a,"$1"+O+"$2")+f}return f}function Be(e,t){var n=e.indexOf(1===t?":":"{"),r=e.substring(0,3!==t?n:10),o=e.substring(n+1,e.length-1);return Ee(2!==t?r:r.replace(S,"$1"),o,t)}function We(e,t){var n=Ue(t,t.charCodeAt(0),t.charCodeAt(1),t.charCodeAt(2));return n!==t+";"?n.replace(C," or ($1)").substring(4):"("+t+")"}function $e(e,t,n,r,o,i,a,u,l,c){for(var s,f=0,d=t;f0&&(Me=o.replace(p,i===z?"":"-")),i=1,1===ve?ze=o:Re=o;var a,u=[ze];Ce>0&&void 0!==(a=$e(Te,n,u,u,he,pe,0,0,0,0))&&"string"==typeof a&&(n=a);var l=Fe(ke,u,n,0,0);return Ce>0&&void 0!==(a=$e(Se,l,u,u,he,pe,l.length,0,0,0))&&"string"!=typeof(l=a)&&(i=0),Me="",ze="",Re="",me=0,he=1,pe=1,be*i==0?l:l.replace(r,"").replace(g,"").replace(y,"$1").replace(b,"$1").replace(w," ")}return Ve.use=function e(t){switch(t){case void 0:case null:Ce=xe.length=0;break;default:switch(t.constructor){case Array:for(var n=0,r=t.length;n1&&void 0!==arguments[1]?arguments[1]:r,n=void 0,o=[],i=void 0,a=!1,u=function(e,n){return t(e,o[n])};return function(){for(var t=arguments.length,r=Array(t),l=0;l + * Copyright OpenJS Foundation and other contributors + * Released under MIT license + * Based on Underscore.js 1.8.3 + * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors + */(function(){var i,a=200,u="Unsupported core-js use. Try https://npms.io/search?q=ponyfill.",l="Expected a function",c="__lodash_hash_undefined__",s=500,f="__lodash_placeholder__",d=1,p=2,h=4,m=1,v=2,g=1,y=2,b=4,w=8,_=16,k=32,x=64,C=128,E=256,S=512,T=30,O="...",j=800,P=16,A=1,I=2,N=1/0,M=9007199254740991,R=1.7976931348623157e308,z=NaN,F=4294967295,L=F-1,D=F>>>1,U=[["ary",C],["bind",g],["bindKey",y],["curry",w],["curryRight",_],["flip",S],["partial",k],["partialRight",x],["rearg",E]],B="[object Arguments]",W="[object Array]",$="[object AsyncFunction]",H="[object Boolean]",V="[object Date]",q="[object DOMException]",G="[object Error]",K="[object Function]",Y="[object GeneratorFunction]",Q="[object Map]",X="[object Number]",Z="[object Null]",J="[object Object]",ee="[object Proxy]",te="[object RegExp]",ne="[object Set]",re="[object String]",oe="[object Symbol]",ie="[object Undefined]",ae="[object WeakMap]",ue="[object WeakSet]",le="[object ArrayBuffer]",ce="[object DataView]",se="[object Float32Array]",fe="[object Float64Array]",de="[object Int8Array]",pe="[object Int16Array]",he="[object Int32Array]",me="[object Uint8Array]",ve="[object Uint8ClampedArray]",ge="[object Uint16Array]",ye="[object Uint32Array]",be=/\b__p \+= '';/g,we=/\b(__p \+=) '' \+/g,_e=/(__e\(.*?\)|\b__t\)) \+\n'';/g,ke=/&(?:amp|lt|gt|quot|#39);/g,xe=/[&<>"']/g,Ce=RegExp(ke.source),Ee=RegExp(xe.source),Se=/<%-([\s\S]+?)%>/g,Te=/<%([\s\S]+?)%>/g,Oe=/<%=([\s\S]+?)%>/g,je=/\.|\[(?:[^[\]]*|(["'])(?:(?!\1)[^\\]|\\.)*?\1)\]/,Pe=/^\w*$/,Ae=/[^.[\]]+|\[(?:(-?\d+(?:\.\d+)?)|(["'])((?:(?!\2)[^\\]|\\.)*?)\2)\]|(?=(?:\.|\[\])(?:\.|\[\]|$))/g,Ie=/[\\^$.*+?()[\]{}|]/g,Ne=RegExp(Ie.source),Me=/^\s+|\s+$/g,Re=/^\s+/,ze=/\s+$/,Fe=/\{(?:\n\/\* \[wrapped with .+\] \*\/)?\n?/,Le=/\{\n\/\* \[wrapped with (.+)\] \*/,De=/,? & /,Ue=/[^\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\x7f]+/g,Be=/\\(\\)?/g,We=/\$\{([^\\}]*(?:\\.[^\\}]*)*)\}/g,$e=/\w*$/,He=/^[-+]0x[0-9a-f]+$/i,Ve=/^0b[01]+$/i,qe=/^\[object .+?Constructor\]$/,Ge=/^0o[0-7]+$/i,Ke=/^(?:0|[1-9]\d*)$/,Ye=/[\xc0-\xd6\xd8-\xf6\xf8-\xff\u0100-\u017f]/g,Qe=/($^)/,Xe=/['\n\r\u2028\u2029\\]/g,Ze="\\u0300-\\u036f\\ufe20-\\ufe2f\\u20d0-\\u20ff",Je="\\xac\\xb1\\xd7\\xf7\\x00-\\x2f\\x3a-\\x40\\x5b-\\x60\\x7b-\\xbf\\u2000-\\u206f \\t\\x0b\\f\\xa0\\ufeff\\n\\r\\u2028\\u2029\\u1680\\u180e\\u2000\\u2001\\u2002\\u2003\\u2004\\u2005\\u2006\\u2007\\u2008\\u2009\\u200a\\u202f\\u205f\\u3000",et="[\\ud800-\\udfff]",tt="["+Je+"]",nt="["+Ze+"]",rt="\\d+",ot="[\\u2700-\\u27bf]",it="[a-z\\xdf-\\xf6\\xf8-\\xff]",at="[^\\ud800-\\udfff"+Je+rt+"\\u2700-\\u27bfa-z\\xdf-\\xf6\\xf8-\\xffA-Z\\xc0-\\xd6\\xd8-\\xde]",ut="\\ud83c[\\udffb-\\udfff]",lt="[^\\ud800-\\udfff]",ct="(?:\\ud83c[\\udde6-\\uddff]){2}",st="[\\ud800-\\udbff][\\udc00-\\udfff]",ft="[A-Z\\xc0-\\xd6\\xd8-\\xde]",dt="(?:"+it+"|"+at+")",pt="(?:"+ft+"|"+at+")",ht="(?:"+nt+"|"+ut+")"+"?",mt="[\\ufe0e\\ufe0f]?"+ht+("(?:\\u200d(?:"+[lt,ct,st].join("|")+")[\\ufe0e\\ufe0f]?"+ht+")*"),vt="(?:"+[ot,ct,st].join("|")+")"+mt,gt="(?:"+[lt+nt+"?",nt,ct,st,et].join("|")+")",yt=RegExp("['’]","g"),bt=RegExp(nt,"g"),wt=RegExp(ut+"(?="+ut+")|"+gt+mt,"g"),_t=RegExp([ft+"?"+it+"+(?:['’](?:d|ll|m|re|s|t|ve))?(?="+[tt,ft,"$"].join("|")+")",pt+"+(?:['’](?:D|LL|M|RE|S|T|VE))?(?="+[tt,ft+dt,"$"].join("|")+")",ft+"?"+dt+"+(?:['’](?:d|ll|m|re|s|t|ve))?",ft+"+(?:['’](?:D|LL|M|RE|S|T|VE))?","\\d*(?:1ST|2ND|3RD|(?![123])\\dTH)(?=\\b|[a-z_])","\\d*(?:1st|2nd|3rd|(?![123])\\dth)(?=\\b|[A-Z_])",rt,vt].join("|"),"g"),kt=RegExp("[\\u200d\\ud800-\\udfff"+Ze+"\\ufe0e\\ufe0f]"),xt=/[a-z][A-Z]|[A-Z]{2}[a-z]|[0-9][a-zA-Z]|[a-zA-Z][0-9]|[^a-zA-Z0-9 ]/,Ct=["Array","Buffer","DataView","Date","Error","Float32Array","Float64Array","Function","Int8Array","Int16Array","Int32Array","Map","Math","Object","Promise","RegExp","Set","String","Symbol","TypeError","Uint8Array","Uint8ClampedArray","Uint16Array","Uint32Array","WeakMap","_","clearTimeout","isFinite","parseInt","setTimeout"],Et=-1,St={};St[se]=St[fe]=St[de]=St[pe]=St[he]=St[me]=St[ve]=St[ge]=St[ye]=!0,St[B]=St[W]=St[le]=St[H]=St[ce]=St[V]=St[G]=St[K]=St[Q]=St[X]=St[J]=St[te]=St[ne]=St[re]=St[ae]=!1;var Tt={};Tt[B]=Tt[W]=Tt[le]=Tt[ce]=Tt[H]=Tt[V]=Tt[se]=Tt[fe]=Tt[de]=Tt[pe]=Tt[he]=Tt[Q]=Tt[X]=Tt[J]=Tt[te]=Tt[ne]=Tt[re]=Tt[oe]=Tt[me]=Tt[ve]=Tt[ge]=Tt[ye]=!0,Tt[G]=Tt[K]=Tt[ae]=!1;var Ot={"\\":"\\","'":"'","\n":"n","\r":"r","\u2028":"u2028","\u2029":"u2029"},jt=parseFloat,Pt=parseInt,At="object"==typeof e&&e&&e.Object===Object&&e,It="object"==typeof self&&self&&self.Object===Object&&self,Nt=At||It||Function("return this")(),Mt="object"==typeof t&&t&&!t.nodeType&&t,Rt=Mt&&"object"==typeof r&&r&&!r.nodeType&&r,zt=Rt&&Rt.exports===Mt,Ft=zt&&At.process,Lt=function(){try{var e=Rt&&Rt.require&&Rt.require("util").types;return e||Ft&&Ft.binding&&Ft.binding("util")}catch(e){}}(),Dt=Lt&&Lt.isArrayBuffer,Ut=Lt&&Lt.isDate,Bt=Lt&&Lt.isMap,Wt=Lt&&Lt.isRegExp,$t=Lt&&Lt.isSet,Ht=Lt&&Lt.isTypedArray;function Vt(e,t,n){switch(n.length){case 0:return e.call(t);case 1:return e.call(t,n[0]);case 2:return e.call(t,n[0],n[1]);case 3:return e.call(t,n[0],n[1],n[2])}return e.apply(t,n)}function qt(e,t,n,r){for(var o=-1,i=null==e?0:e.length;++o-1}function Zt(e,t,n){for(var r=-1,o=null==e?0:e.length;++r-1;);return n}function _n(e,t){for(var n=e.length;n--&&ln(t,e[n],0)>-1;);return n}var kn=pn({"À":"A","Á":"A","Â":"A","Ã":"A","Ä":"A","Å":"A","à":"a","á":"a","â":"a","ã":"a","ä":"a","å":"a","Ç":"C","ç":"c","Ð":"D","ð":"d","È":"E","É":"E","Ê":"E","Ë":"E","è":"e","é":"e","ê":"e","ë":"e","Ì":"I","Í":"I","Î":"I","Ï":"I","ì":"i","í":"i","î":"i","ï":"i","Ñ":"N","ñ":"n","Ò":"O","Ó":"O","Ô":"O","Õ":"O","Ö":"O","Ø":"O","ò":"o","ó":"o","ô":"o","õ":"o","ö":"o","ø":"o","Ù":"U","Ú":"U","Û":"U","Ü":"U","ù":"u","ú":"u","û":"u","ü":"u","Ý":"Y","ý":"y","ÿ":"y","Æ":"Ae","æ":"ae","Þ":"Th","þ":"th","ß":"ss","Ā":"A","Ă":"A","Ą":"A","ā":"a","ă":"a","ą":"a","Ć":"C","Ĉ":"C","Ċ":"C","Č":"C","ć":"c","ĉ":"c","ċ":"c","č":"c","Ď":"D","Đ":"D","ď":"d","đ":"d","Ē":"E","Ĕ":"E","Ė":"E","Ę":"E","Ě":"E","ē":"e","ĕ":"e","ė":"e","ę":"e","ě":"e","Ĝ":"G","Ğ":"G","Ġ":"G","Ģ":"G","ĝ":"g","ğ":"g","ġ":"g","ģ":"g","Ĥ":"H","Ħ":"H","ĥ":"h","ħ":"h","Ĩ":"I","Ī":"I","Ĭ":"I","Į":"I","İ":"I","ĩ":"i","ī":"i","ĭ":"i","į":"i","ı":"i","Ĵ":"J","ĵ":"j","Ķ":"K","ķ":"k","ĸ":"k","Ĺ":"L","Ļ":"L","Ľ":"L","Ŀ":"L","Ł":"L","ĺ":"l","ļ":"l","ľ":"l","ŀ":"l","ł":"l","Ń":"N","Ņ":"N","Ň":"N","Ŋ":"N","ń":"n","ņ":"n","ň":"n","ŋ":"n","Ō":"O","Ŏ":"O","Ő":"O","ō":"o","ŏ":"o","ő":"o","Ŕ":"R","Ŗ":"R","Ř":"R","ŕ":"r","ŗ":"r","ř":"r","Ś":"S","Ŝ":"S","Ş":"S","Š":"S","ś":"s","ŝ":"s","ş":"s","š":"s","Ţ":"T","Ť":"T","Ŧ":"T","ţ":"t","ť":"t","ŧ":"t","Ũ":"U","Ū":"U","Ŭ":"U","Ů":"U","Ű":"U","Ų":"U","ũ":"u","ū":"u","ŭ":"u","ů":"u","ű":"u","ų":"u","Ŵ":"W","ŵ":"w","Ŷ":"Y","ŷ":"y","Ÿ":"Y","Ź":"Z","Ż":"Z","Ž":"Z","ź":"z","ż":"z","ž":"z","IJ":"IJ","ij":"ij","Œ":"Oe","œ":"oe","ʼn":"'n","ſ":"s"}),xn=pn({"&":"&","<":"<",">":">",'"':""","'":"'"});function Cn(e){return"\\"+Ot[e]}function En(e){return kt.test(e)}function Sn(e){var t=-1,n=Array(e.size);return e.forEach(function(e,r){n[++t]=[r,e]}),n}function Tn(e,t){return function(n){return e(t(n))}}function On(e,t){for(var n=-1,r=e.length,o=0,i=[];++n",""":'"',"'":"'"});var Mn=function e(t){var n,r=(t=null==t?Nt:Mn.defaults(Nt.Object(),t,Mn.pick(Nt,Ct))).Array,o=t.Date,Ze=t.Error,Je=t.Function,et=t.Math,tt=t.Object,nt=t.RegExp,rt=t.String,ot=t.TypeError,it=r.prototype,at=Je.prototype,ut=tt.prototype,lt=t["__core-js_shared__"],ct=at.toString,st=ut.hasOwnProperty,ft=0,dt=(n=/[^.]+$/.exec(lt&<.keys&<.keys.IE_PROTO||""))?"Symbol(src)_1."+n:"",pt=ut.toString,ht=ct.call(tt),mt=Nt._,vt=nt("^"+ct.call(st).replace(Ie,"\\$&").replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g,"$1.*?")+"$"),gt=zt?t.Buffer:i,wt=t.Symbol,kt=t.Uint8Array,Ot=gt?gt.allocUnsafe:i,At=Tn(tt.getPrototypeOf,tt),It=tt.create,Mt=ut.propertyIsEnumerable,Rt=it.splice,Ft=wt?wt.isConcatSpreadable:i,Lt=wt?wt.iterator:i,on=wt?wt.toStringTag:i,pn=function(){try{var e=Di(tt,"defineProperty");return e({},"",{}),e}catch(e){}}(),Rn=t.clearTimeout!==Nt.clearTimeout&&t.clearTimeout,zn=o&&o.now!==Nt.Date.now&&o.now,Fn=t.setTimeout!==Nt.setTimeout&&t.setTimeout,Ln=et.ceil,Dn=et.floor,Un=tt.getOwnPropertySymbols,Bn=gt?gt.isBuffer:i,Wn=t.isFinite,$n=it.join,Hn=Tn(tt.keys,tt),Vn=et.max,qn=et.min,Gn=o.now,Kn=t.parseInt,Yn=et.random,Qn=it.reverse,Xn=Di(t,"DataView"),Zn=Di(t,"Map"),Jn=Di(t,"Promise"),er=Di(t,"Set"),tr=Di(t,"WeakMap"),nr=Di(tt,"create"),rr=tr&&new tr,or={},ir=fa(Xn),ar=fa(Zn),ur=fa(Jn),lr=fa(er),cr=fa(tr),sr=wt?wt.prototype:i,fr=sr?sr.valueOf:i,dr=sr?sr.toString:i;function pr(e){if(Ou(e)&&!gu(e)&&!(e instanceof gr)){if(e instanceof vr)return e;if(st.call(e,"__wrapped__"))return da(e)}return new vr(e)}var hr=function(){function e(){}return function(t){if(!Tu(t))return{};if(It)return It(t);e.prototype=t;var n=new e;return e.prototype=i,n}}();function mr(){}function vr(e,t){this.__wrapped__=e,this.__actions__=[],this.__chain__=!!t,this.__index__=0,this.__values__=i}function gr(e){this.__wrapped__=e,this.__actions__=[],this.__dir__=1,this.__filtered__=!1,this.__iteratees__=[],this.__takeCount__=F,this.__views__=[]}function yr(e){var t=-1,n=null==e?0:e.length;for(this.clear();++t=t?e:t)),e}function Rr(e,t,n,r,o,a){var u,l=t&d,c=t&p,s=t&h;if(n&&(u=o?n(e,r,o,a):n(e)),u!==i)return u;if(!Tu(e))return e;var f=gu(e);if(f){if(u=function(e){var t=e.length,n=new e.constructor(t);return t&&"string"==typeof e[0]&&st.call(e,"index")&&(n.index=e.index,n.input=e.input),n}(e),!l)return ri(e,u)}else{var m=Wi(e),v=m==K||m==Y;if(_u(e))return Xo(e,l);if(m==J||m==B||v&&!o){if(u=c||v?{}:Hi(e),!l)return c?function(e,t){return oi(e,Bi(e),t)}(e,function(e,t){return e&&oi(t,il(t),e)}(u,e)):function(e,t){return oi(e,Ui(e),t)}(e,Ar(u,e))}else{if(!Tt[m])return o?e:{};u=function(e,t,n){var r,o,i,a=e.constructor;switch(t){case le:return Zo(e);case H:case V:return new a(+e);case ce:return function(e,t){var n=t?Zo(e.buffer):e.buffer;return new e.constructor(n,e.byteOffset,e.byteLength)}(e,n);case se:case fe:case de:case pe:case he:case me:case ve:case ge:case ye:return Jo(e,n);case Q:return new a;case X:case re:return new a(e);case te:return(i=new(o=e).constructor(o.source,$e.exec(o))).lastIndex=o.lastIndex,i;case ne:return new a;case oe:return r=e,fr?tt(fr.call(r)):{}}}(e,m,l)}}a||(a=new kr);var g=a.get(e);if(g)return g;a.set(e,u),Nu(e)?e.forEach(function(r){u.add(Rr(r,t,n,r,e,a))}):ju(e)&&e.forEach(function(r,o){u.set(o,Rr(r,t,n,o,e,a))});var y=f?i:(s?c?Ii:Ai:c?il:ol)(e);return Gt(y||e,function(r,o){y&&(r=e[o=r]),Or(u,o,Rr(r,t,n,o,e,a))}),u}function zr(e,t,n){var r=n.length;if(null==e)return!r;for(e=tt(e);r--;){var o=n[r],a=t[o],u=e[o];if(u===i&&!(o in e)||!a(u))return!1}return!0}function Fr(e,t,n){if("function"!=typeof e)throw new ot(l);return oa(function(){e.apply(i,n)},t)}function Lr(e,t,n,r){var o=-1,i=Xt,u=!0,l=e.length,c=[],s=t.length;if(!l)return c;n&&(t=Jt(t,gn(n))),r?(i=Zt,u=!1):t.length>=a&&(i=bn,u=!1,t=new _r(t));e:for(;++o-1},br.prototype.set=function(e,t){var n=this.__data__,r=jr(n,e);return r<0?(++this.size,n.push([e,t])):n[r][1]=t,this},wr.prototype.clear=function(){this.size=0,this.__data__={hash:new yr,map:new(Zn||br),string:new yr}},wr.prototype.delete=function(e){var t=Fi(this,e).delete(e);return this.size-=t?1:0,t},wr.prototype.get=function(e){return Fi(this,e).get(e)},wr.prototype.has=function(e){return Fi(this,e).has(e)},wr.prototype.set=function(e,t){var n=Fi(this,e),r=n.size;return n.set(e,t),this.size+=n.size==r?0:1,this},_r.prototype.add=_r.prototype.push=function(e){return this.__data__.set(e,c),this},_r.prototype.has=function(e){return this.__data__.has(e)},kr.prototype.clear=function(){this.__data__=new br,this.size=0},kr.prototype.delete=function(e){var t=this.__data__,n=t.delete(e);return this.size=t.size,n},kr.prototype.get=function(e){return this.__data__.get(e)},kr.prototype.has=function(e){return this.__data__.has(e)},kr.prototype.set=function(e,t){var n=this.__data__;if(n instanceof br){var r=n.__data__;if(!Zn||r.length0&&n(u)?t>1?Hr(u,t-1,n,r,o):en(o,u):r||(o[o.length]=u)}return o}var Vr=li(),qr=li(!0);function Gr(e,t){return e&&Vr(e,t,ol)}function Kr(e,t){return e&&qr(e,t,ol)}function Yr(e,t){return Qt(t,function(t){return Cu(e[t])})}function Qr(e,t){for(var n=0,r=(t=Go(t,e)).length;null!=e&&nt}function eo(e,t){return null!=e&&st.call(e,t)}function to(e,t){return null!=e&&t in tt(e)}function no(e,t,n){for(var o=n?Zt:Xt,a=e[0].length,u=e.length,l=u,c=r(u),s=1/0,f=[];l--;){var d=e[l];l&&t&&(d=Jt(d,gn(t))),s=qn(d.length,s),c[l]=!n&&(t||a>=120&&d.length>=120)?new _r(l&&d):i}d=e[0];var p=-1,h=c[0];e:for(;++p=u)return l;var c=n[r];return l*("desc"==c?-1:1)}}return e.index-t.index}(e,t,n)})}function bo(e,t,n){for(var r=-1,o=t.length,i={};++r-1;)u!==e&&Rt.call(u,l,1),Rt.call(e,l,1);return e}function _o(e,t){for(var n=e?t.length:0,r=n-1;n--;){var o=t[n];if(n==r||o!==i){var i=o;qi(o)?Rt.call(e,o,1):Do(e,o)}}return e}function ko(e,t){return e+Dn(Yn()*(t-e+1))}function xo(e,t){var n="";if(!e||t<1||t>M)return n;do{t%2&&(n+=e),(t=Dn(t/2))&&(e+=e)}while(t);return n}function Co(e,t){return ia(ea(e,t,Pl),e+"")}function Eo(e){return Cr(pl(e))}function So(e,t){var n=pl(e);return la(n,Mr(t,0,n.length))}function To(e,t,n,r){if(!Tu(e))return e;for(var o=-1,a=(t=Go(t,e)).length,u=a-1,l=e;null!=l&&++oi?0:i+t),(n=n>i?i:n)<0&&(n+=i),i=t>n?0:n-t>>>0,t>>>=0;for(var a=r(i);++o>>1,a=e[i];null!==a&&!Ru(a)&&(n?a<=t:a=a){var s=t?null:xi(e);if(s)return jn(s);u=!1,o=bn,c=new _r}else c=t?[]:l;e:for(;++r=r?e:Ao(e,t,n)}var Qo=Rn||function(e){return Nt.clearTimeout(e)};function Xo(e,t){if(t)return e.slice();var n=e.length,r=Ot?Ot(n):new e.constructor(n);return e.copy(r),r}function Zo(e){var t=new e.constructor(e.byteLength);return new kt(t).set(new kt(e)),t}function Jo(e,t){var n=t?Zo(e.buffer):e.buffer;return new e.constructor(n,e.byteOffset,e.length)}function ei(e,t){if(e!==t){var n=e!==i,r=null===e,o=e==e,a=Ru(e),u=t!==i,l=null===t,c=t==t,s=Ru(t);if(!l&&!s&&!a&&e>t||a&&u&&c&&!l&&!s||r&&u&&c||!n&&c||!o)return 1;if(!r&&!a&&!s&&e1?n[o-1]:i,u=o>2?n[2]:i;for(a=e.length>3&&"function"==typeof a?(o--,a):i,u&&Gi(n[0],n[1],u)&&(a=o<3?i:a,o=1),t=tt(t);++r-1?o[a?t[u]:u]:i}}function pi(e){return Pi(function(t){var n=t.length,r=n,o=vr.prototype.thru;for(e&&t.reverse();r--;){var a=t[r];if("function"!=typeof a)throw new ot(l);if(o&&!u&&"wrapper"==Mi(a))var u=new vr([],!0)}for(r=u?r:n;++r1&&w.reverse(),d&&sl))return!1;var s=a.get(e);if(s&&a.get(t))return s==t;var f=-1,d=!0,p=n&v?new _r:i;for(a.set(e,t),a.set(t,e);++f-1&&e%1==0&&e1?"& ":"")+t[r],t=t.join(n>2?", ":" "),e.replace(Fe,"{\n/* [wrapped with "+t+"] */\n")}(r,function(e,t){return Gt(U,function(n){var r="_."+n[0];t&n[1]&&!Xt(e,r)&&e.push(r)}),e.sort()}(function(e){var t=e.match(Le);return t?t[1].split(De):[]}(r),n)))}function ua(e){var t=0,n=0;return function(){var r=Gn(),o=P-(r-n);if(n=r,o>0){if(++t>=j)return arguments[0]}else t=0;return e.apply(i,arguments)}}function la(e,t){var n=-1,r=e.length,o=r-1;for(t=t===i?r:t;++n1?e[t-1]:i;return n="function"==typeof n?(e.pop(),n):i,Ia(e,n)});function Da(e){var t=pr(e);return t.__chain__=!0,t}function Ua(e,t){return t(e)}var Ba=Pi(function(e){var t=e.length,n=t?e[0]:0,r=this.__wrapped__,o=function(t){return Nr(t,e)};return!(t>1||this.__actions__.length)&&r instanceof gr&&qi(n)?((r=r.slice(n,+n+(t?1:0))).__actions__.push({func:Ua,args:[o],thisArg:i}),new vr(r,this.__chain__).thru(function(e){return t&&!e.length&&e.push(i),e})):this.thru(o)});var Wa=ii(function(e,t,n){st.call(e,n)?++e[n]:Ir(e,n,1)});var $a=di(va),Ha=di(ga);function Va(e,t){return(gu(e)?Gt:Dr)(e,zi(t,3))}function qa(e,t){return(gu(e)?Kt:Ur)(e,zi(t,3))}var Ga=ii(function(e,t,n){st.call(e,n)?e[n].push(t):Ir(e,n,[t])});var Ka=Co(function(e,t,n){var o=-1,i="function"==typeof t,a=bu(e)?r(e.length):[];return Dr(e,function(e){a[++o]=i?Vt(t,e,n):ro(e,t,n)}),a}),Ya=ii(function(e,t,n){Ir(e,n,t)});function Qa(e,t){return(gu(e)?Jt:po)(e,zi(t,3))}var Xa=ii(function(e,t,n){e[n?0:1].push(t)},function(){return[[],[]]});var Za=Co(function(e,t){if(null==e)return[];var n=t.length;return n>1&&Gi(e,t[0],t[1])?t=[]:n>2&&Gi(t[0],t[1],t[2])&&(t=[t[0]]),yo(e,Hr(t,1),[])}),Ja=zn||function(){return Nt.Date.now()};function eu(e,t,n){return t=n?i:t,t=e&&null==t?e.length:t,Ei(e,C,i,i,i,i,t)}function tu(e,t){var n;if("function"!=typeof t)throw new ot(l);return e=Bu(e),function(){return--e>0&&(n=t.apply(this,arguments)),e<=1&&(t=i),n}}var nu=Co(function(e,t,n){var r=g;if(n.length){var o=On(n,Ri(nu));r|=k}return Ei(e,r,t,n,o)}),ru=Co(function(e,t,n){var r=g|y;if(n.length){var o=On(n,Ri(ru));r|=k}return Ei(t,r,e,n,o)});function ou(e,t,n){var r,o,a,u,c,s,f=0,d=!1,p=!1,h=!0;if("function"!=typeof e)throw new ot(l);function m(t){var n=r,a=o;return r=o=i,f=t,u=e.apply(a,n)}function v(e){var n=e-s;return s===i||n>=t||n<0||p&&e-f>=a}function g(){var e=Ja();if(v(e))return y(e);c=oa(g,function(e){var n=t-(e-s);return p?qn(n,a-(e-f)):n}(e))}function y(e){return c=i,h&&r?m(e):(r=o=i,u)}function b(){var e=Ja(),n=v(e);if(r=arguments,o=this,s=e,n){if(c===i)return function(e){return f=e,c=oa(g,t),d?m(e):u}(s);if(p)return Qo(c),c=oa(g,t),m(s)}return c===i&&(c=oa(g,t)),u}return t=$u(t)||0,Tu(n)&&(d=!!n.leading,a=(p="maxWait"in n)?Vn($u(n.maxWait)||0,t):a,h="trailing"in n?!!n.trailing:h),b.cancel=function(){c!==i&&Qo(c),f=0,r=s=o=c=i},b.flush=function(){return c===i?u:y(Ja())},b}var iu=Co(function(e,t){return Fr(e,1,t)}),au=Co(function(e,t,n){return Fr(e,$u(t)||0,n)});function uu(e,t){if("function"!=typeof e||null!=t&&"function"!=typeof t)throw new ot(l);var n=function(){var r=arguments,o=t?t.apply(this,r):r[0],i=n.cache;if(i.has(o))return i.get(o);var a=e.apply(this,r);return n.cache=i.set(o,a)||i,a};return n.cache=new(uu.Cache||wr),n}function lu(e){if("function"!=typeof e)throw new ot(l);return function(){var t=arguments;switch(t.length){case 0:return!e.call(this);case 1:return!e.call(this,t[0]);case 2:return!e.call(this,t[0],t[1]);case 3:return!e.call(this,t[0],t[1],t[2])}return!e.apply(this,t)}}uu.Cache=wr;var cu=Ko(function(e,t){var n=(t=1==t.length&&gu(t[0])?Jt(t[0],gn(zi())):Jt(Hr(t,1),gn(zi()))).length;return Co(function(r){for(var o=-1,i=qn(r.length,n);++o=t}),vu=oo(function(){return arguments}())?oo:function(e){return Ou(e)&&st.call(e,"callee")&&!Mt.call(e,"callee")},gu=r.isArray,yu=Dt?gn(Dt):function(e){return Ou(e)&&Zr(e)==le};function bu(e){return null!=e&&Su(e.length)&&!Cu(e)}function wu(e){return Ou(e)&&bu(e)}var _u=Bn||$l,ku=Ut?gn(Ut):function(e){return Ou(e)&&Zr(e)==V};function xu(e){if(!Ou(e))return!1;var t=Zr(e);return t==G||t==q||"string"==typeof e.message&&"string"==typeof e.name&&!Au(e)}function Cu(e){if(!Tu(e))return!1;var t=Zr(e);return t==K||t==Y||t==$||t==ee}function Eu(e){return"number"==typeof e&&e==Bu(e)}function Su(e){return"number"==typeof e&&e>-1&&e%1==0&&e<=M}function Tu(e){var t=typeof e;return null!=e&&("object"==t||"function"==t)}function Ou(e){return null!=e&&"object"==typeof e}var ju=Bt?gn(Bt):function(e){return Ou(e)&&Wi(e)==Q};function Pu(e){return"number"==typeof e||Ou(e)&&Zr(e)==X}function Au(e){if(!Ou(e)||Zr(e)!=J)return!1;var t=At(e);if(null===t)return!0;var n=st.call(t,"constructor")&&t.constructor;return"function"==typeof n&&n instanceof n&&ct.call(n)==ht}var Iu=Wt?gn(Wt):function(e){return Ou(e)&&Zr(e)==te};var Nu=$t?gn($t):function(e){return Ou(e)&&Wi(e)==ne};function Mu(e){return"string"==typeof e||!gu(e)&&Ou(e)&&Zr(e)==re}function Ru(e){return"symbol"==typeof e||Ou(e)&&Zr(e)==oe}var zu=Ht?gn(Ht):function(e){return Ou(e)&&Su(e.length)&&!!St[Zr(e)]};var Fu=wi(fo),Lu=wi(function(e,t){return e<=t});function Du(e){if(!e)return[];if(bu(e))return Mu(e)?In(e):ri(e);if(Lt&&e[Lt])return function(e){for(var t,n=[];!(t=e.next()).done;)n.push(t.value);return n}(e[Lt]());var t=Wi(e);return(t==Q?Sn:t==ne?jn:pl)(e)}function Uu(e){return e?(e=$u(e))===N||e===-N?(e<0?-1:1)*R:e==e?e:0:0===e?e:0}function Bu(e){var t=Uu(e),n=t%1;return t==t?n?t-n:t:0}function Wu(e){return e?Mr(Bu(e),0,F):0}function $u(e){if("number"==typeof e)return e;if(Ru(e))return z;if(Tu(e)){var t="function"==typeof e.valueOf?e.valueOf():e;e=Tu(t)?t+"":t}if("string"!=typeof e)return 0===e?e:+e;e=e.replace(Me,"");var n=Ve.test(e);return n||Ge.test(e)?Pt(e.slice(2),n?2:8):He.test(e)?z:+e}function Hu(e){return oi(e,il(e))}function Vu(e){return null==e?"":Fo(e)}var qu=ai(function(e,t){if(Xi(t)||bu(t))oi(t,ol(t),e);else for(var n in t)st.call(t,n)&&Or(e,n,t[n])}),Gu=ai(function(e,t){oi(t,il(t),e)}),Ku=ai(function(e,t,n,r){oi(t,il(t),e,r)}),Yu=ai(function(e,t,n,r){oi(t,ol(t),e,r)}),Qu=Pi(Nr);var Xu=Co(function(e,t){e=tt(e);var n=-1,r=t.length,o=r>2?t[2]:i;for(o&&Gi(t[0],t[1],o)&&(r=1);++n1),t}),oi(e,Ii(e),n),r&&(n=Rr(n,d|p|h,Oi));for(var o=t.length;o--;)Do(n,t[o]);return n});var cl=Pi(function(e,t){return null==e?{}:function(e,t){return bo(e,t,function(t,n){return el(e,n)})}(e,t)});function sl(e,t){if(null==e)return{};var n=Jt(Ii(e),function(e){return[e]});return t=zi(t),bo(e,n,function(e,n){return t(e,n[0])})}var fl=Ci(ol),dl=Ci(il);function pl(e){return null==e?[]:yn(e,ol(e))}var hl=si(function(e,t,n){return t=t.toLowerCase(),e+(n?ml(t):t)});function ml(e){return xl(Vu(e).toLowerCase())}function vl(e){return(e=Vu(e))&&e.replace(Ye,kn).replace(bt,"")}var gl=si(function(e,t,n){return e+(n?"-":"")+t.toLowerCase()}),yl=si(function(e,t,n){return e+(n?" ":"")+t.toLowerCase()}),bl=ci("toLowerCase");var wl=si(function(e,t,n){return e+(n?"_":"")+t.toLowerCase()});var _l=si(function(e,t,n){return e+(n?" ":"")+xl(t)});var kl=si(function(e,t,n){return e+(n?" ":"")+t.toUpperCase()}),xl=ci("toUpperCase");function Cl(e,t,n){return e=Vu(e),(t=n?i:t)===i?function(e){return xt.test(e)}(e)?function(e){return e.match(_t)||[]}(e):function(e){return e.match(Ue)||[]}(e):e.match(t)||[]}var El=Co(function(e,t){try{return Vt(e,i,t)}catch(e){return xu(e)?e:new Ze(e)}}),Sl=Pi(function(e,t){return Gt(t,function(t){t=sa(t),Ir(e,t,nu(e[t],e))}),e});function Tl(e){return function(){return e}}var Ol=pi(),jl=pi(!0);function Pl(e){return e}function Al(e){return lo("function"==typeof e?e:Rr(e,d))}var Il=Co(function(e,t){return function(n){return ro(n,e,t)}}),Nl=Co(function(e,t){return function(n){return ro(e,n,t)}});function Ml(e,t,n){var r=ol(t),o=Yr(t,r);null!=n||Tu(t)&&(o.length||!r.length)||(n=t,t=e,e=this,o=Yr(t,ol(t)));var i=!(Tu(n)&&"chain"in n&&!n.chain),a=Cu(e);return Gt(o,function(n){var r=t[n];e[n]=r,a&&(e.prototype[n]=function(){var t=this.__chain__;if(i||t){var n=e(this.__wrapped__);return(n.__actions__=ri(this.__actions__)).push({func:r,args:arguments,thisArg:e}),n.__chain__=t,n}return r.apply(e,en([this.value()],arguments))})}),e}function Rl(){}var zl=gi(Jt),Fl=gi(Yt),Ll=gi(rn);function Dl(e){return Ki(e)?dn(sa(e)):function(e){return function(t){return Qr(t,e)}}(e)}var Ul=bi(),Bl=bi(!0);function Wl(){return[]}function $l(){return!1}var Hl=vi(function(e,t){return e+t},0),Vl=ki("ceil"),ql=vi(function(e,t){return e/t},1),Gl=ki("floor");var Kl,Yl=vi(function(e,t){return e*t},1),Ql=ki("round"),Xl=vi(function(e,t){return e-t},0);return pr.after=function(e,t){if("function"!=typeof t)throw new ot(l);return e=Bu(e),function(){if(--e<1)return t.apply(this,arguments)}},pr.ary=eu,pr.assign=qu,pr.assignIn=Gu,pr.assignInWith=Ku,pr.assignWith=Yu,pr.at=Qu,pr.before=tu,pr.bind=nu,pr.bindAll=Sl,pr.bindKey=ru,pr.castArray=function(){if(!arguments.length)return[];var e=arguments[0];return gu(e)?e:[e]},pr.chain=Da,pr.chunk=function(e,t,n){t=(n?Gi(e,t,n):t===i)?1:Vn(Bu(t),0);var o=null==e?0:e.length;if(!o||t<1)return[];for(var a=0,u=0,l=r(Ln(o/t));ao?0:o+n),(r=r===i||r>o?o:Bu(r))<0&&(r+=o),r=n>r?0:Wu(r);n>>0)?(e=Vu(e))&&("string"==typeof t||null!=t&&!Iu(t))&&!(t=Fo(t))&&En(e)?Yo(In(e),0,n):e.split(t,n):[]},pr.spread=function(e,t){if("function"!=typeof e)throw new ot(l);return t=null==t?0:Vn(Bu(t),0),Co(function(n){var r=n[t],o=Yo(n,0,t);return r&&en(o,r),Vt(e,this,o)})},pr.tail=function(e){var t=null==e?0:e.length;return t?Ao(e,1,t):[]},pr.take=function(e,t,n){return e&&e.length?Ao(e,0,(t=n||t===i?1:Bu(t))<0?0:t):[]},pr.takeRight=function(e,t,n){var r=null==e?0:e.length;return r?Ao(e,(t=r-(t=n||t===i?1:Bu(t)))<0?0:t,r):[]},pr.takeRightWhile=function(e,t){return e&&e.length?Bo(e,zi(t,3),!1,!0):[]},pr.takeWhile=function(e,t){return e&&e.length?Bo(e,zi(t,3)):[]},pr.tap=function(e,t){return t(e),e},pr.throttle=function(e,t,n){var r=!0,o=!0;if("function"!=typeof e)throw new ot(l);return Tu(n)&&(r="leading"in n?!!n.leading:r,o="trailing"in n?!!n.trailing:o),ou(e,t,{leading:r,maxWait:t,trailing:o})},pr.thru=Ua,pr.toArray=Du,pr.toPairs=fl,pr.toPairsIn=dl,pr.toPath=function(e){return gu(e)?Jt(e,sa):Ru(e)?[e]:ri(ca(Vu(e)))},pr.toPlainObject=Hu,pr.transform=function(e,t,n){var r=gu(e),o=r||_u(e)||zu(e);if(t=zi(t,4),null==n){var i=e&&e.constructor;n=o?r?new i:[]:Tu(e)&&Cu(i)?hr(At(e)):{}}return(o?Gt:Gr)(e,function(e,r,o){return t(n,e,r,o)}),n},pr.unary=function(e){return eu(e,1)},pr.union=Oa,pr.unionBy=ja,pr.unionWith=Pa,pr.uniq=function(e){return e&&e.length?Lo(e):[]},pr.uniqBy=function(e,t){return e&&e.length?Lo(e,zi(t,2)):[]},pr.uniqWith=function(e,t){return t="function"==typeof t?t:i,e&&e.length?Lo(e,i,t):[]},pr.unset=function(e,t){return null==e||Do(e,t)},pr.unzip=Aa,pr.unzipWith=Ia,pr.update=function(e,t,n){return null==e?e:Uo(e,t,qo(n))},pr.updateWith=function(e,t,n,r){return r="function"==typeof r?r:i,null==e?e:Uo(e,t,qo(n),r)},pr.values=pl,pr.valuesIn=function(e){return null==e?[]:yn(e,il(e))},pr.without=Na,pr.words=Cl,pr.wrap=function(e,t){return su(qo(t),e)},pr.xor=Ma,pr.xorBy=Ra,pr.xorWith=za,pr.zip=Fa,pr.zipObject=function(e,t){return Ho(e||[],t||[],Or)},pr.zipObjectDeep=function(e,t){return Ho(e||[],t||[],To)},pr.zipWith=La,pr.entries=fl,pr.entriesIn=dl,pr.extend=Gu,pr.extendWith=Ku,Ml(pr,pr),pr.add=Hl,pr.attempt=El,pr.camelCase=hl,pr.capitalize=ml,pr.ceil=Vl,pr.clamp=function(e,t,n){return n===i&&(n=t,t=i),n!==i&&(n=(n=$u(n))==n?n:0),t!==i&&(t=(t=$u(t))==t?t:0),Mr($u(e),t,n)},pr.clone=function(e){return Rr(e,h)},pr.cloneDeep=function(e){return Rr(e,d|h)},pr.cloneDeepWith=function(e,t){return Rr(e,d|h,t="function"==typeof t?t:i)},pr.cloneWith=function(e,t){return Rr(e,h,t="function"==typeof t?t:i)},pr.conformsTo=function(e,t){return null==t||zr(e,t,ol(t))},pr.deburr=vl,pr.defaultTo=function(e,t){return null==e||e!=e?t:e},pr.divide=ql,pr.endsWith=function(e,t,n){e=Vu(e),t=Fo(t);var r=e.length,o=n=n===i?r:Mr(Bu(n),0,r);return(n-=t.length)>=0&&e.slice(n,o)==t},pr.eq=pu,pr.escape=function(e){return(e=Vu(e))&&Ee.test(e)?e.replace(xe,xn):e},pr.escapeRegExp=function(e){return(e=Vu(e))&&Ne.test(e)?e.replace(Ie,"\\$&"):e},pr.every=function(e,t,n){var r=gu(e)?Yt:Br;return n&&Gi(e,t,n)&&(t=i),r(e,zi(t,3))},pr.find=$a,pr.findIndex=va,pr.findKey=function(e,t){return an(e,zi(t,3),Gr)},pr.findLast=Ha,pr.findLastIndex=ga,pr.findLastKey=function(e,t){return an(e,zi(t,3),Kr)},pr.floor=Gl,pr.forEach=Va,pr.forEachRight=qa,pr.forIn=function(e,t){return null==e?e:Vr(e,zi(t,3),il)},pr.forInRight=function(e,t){return null==e?e:qr(e,zi(t,3),il)},pr.forOwn=function(e,t){return e&&Gr(e,zi(t,3))},pr.forOwnRight=function(e,t){return e&&Kr(e,zi(t,3))},pr.get=Ju,pr.gt=hu,pr.gte=mu,pr.has=function(e,t){return null!=e&&$i(e,t,eo)},pr.hasIn=el,pr.head=ba,pr.identity=Pl,pr.includes=function(e,t,n,r){e=bu(e)?e:pl(e),n=n&&!r?Bu(n):0;var o=e.length;return n<0&&(n=Vn(o+n,0)),Mu(e)?n<=o&&e.indexOf(t,n)>-1:!!o&&ln(e,t,n)>-1},pr.indexOf=function(e,t,n){var r=null==e?0:e.length;if(!r)return-1;var o=null==n?0:Bu(n);return o<0&&(o=Vn(r+o,0)),ln(e,t,o)},pr.inRange=function(e,t,n){return t=Uu(t),n===i?(n=t,t=0):n=Uu(n),function(e,t,n){return e>=qn(t,n)&&e=-M&&e<=M},pr.isSet=Nu,pr.isString=Mu,pr.isSymbol=Ru,pr.isTypedArray=zu,pr.isUndefined=function(e){return e===i},pr.isWeakMap=function(e){return Ou(e)&&Wi(e)==ae},pr.isWeakSet=function(e){return Ou(e)&&Zr(e)==ue},pr.join=function(e,t){return null==e?"":$n.call(e,t)},pr.kebabCase=gl,pr.last=xa,pr.lastIndexOf=function(e,t,n){var r=null==e?0:e.length;if(!r)return-1;var o=r;return n!==i&&(o=(o=Bu(n))<0?Vn(r+o,0):qn(o,r-1)),t==t?function(e,t,n){for(var r=n+1;r--;)if(e[r]===t)return r;return r}(e,t,o):un(e,sn,o,!0)},pr.lowerCase=yl,pr.lowerFirst=bl,pr.lt=Fu,pr.lte=Lu,pr.max=function(e){return e&&e.length?Wr(e,Pl,Jr):i},pr.maxBy=function(e,t){return e&&e.length?Wr(e,zi(t,2),Jr):i},pr.mean=function(e){return fn(e,Pl)},pr.meanBy=function(e,t){return fn(e,zi(t,2))},pr.min=function(e){return e&&e.length?Wr(e,Pl,fo):i},pr.minBy=function(e,t){return e&&e.length?Wr(e,zi(t,2),fo):i},pr.stubArray=Wl,pr.stubFalse=$l,pr.stubObject=function(){return{}},pr.stubString=function(){return""},pr.stubTrue=function(){return!0},pr.multiply=Yl,pr.nth=function(e,t){return e&&e.length?go(e,Bu(t)):i},pr.noConflict=function(){return Nt._===this&&(Nt._=mt),this},pr.noop=Rl,pr.now=Ja,pr.pad=function(e,t,n){e=Vu(e);var r=(t=Bu(t))?An(e):0;if(!t||r>=t)return e;var o=(t-r)/2;return yi(Dn(o),n)+e+yi(Ln(o),n)},pr.padEnd=function(e,t,n){e=Vu(e);var r=(t=Bu(t))?An(e):0;return t&&rt){var r=e;e=t,t=r}if(n||e%1||t%1){var o=Yn();return qn(e+o*(t-e+jt("1e-"+((o+"").length-1))),t)}return ko(e,t)},pr.reduce=function(e,t,n){var r=gu(e)?tn:hn,o=arguments.length<3;return r(e,zi(t,4),n,o,Dr)},pr.reduceRight=function(e,t,n){var r=gu(e)?nn:hn,o=arguments.length<3;return r(e,zi(t,4),n,o,Ur)},pr.repeat=function(e,t,n){return t=(n?Gi(e,t,n):t===i)?1:Bu(t),xo(Vu(e),t)},pr.replace=function(){var e=arguments,t=Vu(e[0]);return e.length<3?t:t.replace(e[1],e[2])},pr.result=function(e,t,n){var r=-1,o=(t=Go(t,e)).length;for(o||(o=1,e=i);++rM)return[];var n=F,r=qn(e,F);t=zi(t),e-=F;for(var o=vn(r,t);++n=a)return e;var l=n-An(r);if(l<1)return r;var c=u?Yo(u,0,l).join(""):e.slice(0,l);if(o===i)return c+r;if(u&&(l+=c.length-l),Iu(o)){if(e.slice(l).search(o)){var s,f=c;for(o.global||(o=nt(o.source,Vu($e.exec(o))+"g")),o.lastIndex=0;s=o.exec(f);)var d=s.index;c=c.slice(0,d===i?l:d)}}else if(e.indexOf(Fo(o),l)!=l){var p=c.lastIndexOf(o);p>-1&&(c=c.slice(0,p))}return c+r},pr.unescape=function(e){return(e=Vu(e))&&Ce.test(e)?e.replace(ke,Nn):e},pr.uniqueId=function(e){var t=++ft;return Vu(e)+t},pr.upperCase=kl,pr.upperFirst=xl,pr.each=Va,pr.eachRight=qa,pr.first=ba,Ml(pr,(Kl={},Gr(pr,function(e,t){st.call(pr.prototype,t)||(Kl[t]=e)}),Kl),{chain:!1}),pr.VERSION="4.17.15",Gt(["bind","bindKey","curry","curryRight","partial","partialRight"],function(e){pr[e].placeholder=pr}),Gt(["drop","take"],function(e,t){gr.prototype[e]=function(n){n=n===i?1:Vn(Bu(n),0);var r=this.__filtered__&&!t?new gr(this):this.clone();return r.__filtered__?r.__takeCount__=qn(n,r.__takeCount__):r.__views__.push({size:qn(n,F),type:e+(r.__dir__<0?"Right":"")}),r},gr.prototype[e+"Right"]=function(t){return this.reverse()[e](t).reverse()}}),Gt(["filter","map","takeWhile"],function(e,t){var n=t+1,r=n==A||3==n;gr.prototype[e]=function(e){var t=this.clone();return t.__iteratees__.push({iteratee:zi(e,3),type:n}),t.__filtered__=t.__filtered__||r,t}}),Gt(["head","last"],function(e,t){var n="take"+(t?"Right":"");gr.prototype[e]=function(){return this[n](1).value()[0]}}),Gt(["initial","tail"],function(e,t){var n="drop"+(t?"":"Right");gr.prototype[e]=function(){return this.__filtered__?new gr(this):this[n](1)}}),gr.prototype.compact=function(){return this.filter(Pl)},gr.prototype.find=function(e){return this.filter(e).head()},gr.prototype.findLast=function(e){return this.reverse().find(e)},gr.prototype.invokeMap=Co(function(e,t){return"function"==typeof e?new gr(this):this.map(function(n){return ro(n,e,t)})}),gr.prototype.reject=function(e){return this.filter(lu(zi(e)))},gr.prototype.slice=function(e,t){e=Bu(e);var n=this;return n.__filtered__&&(e>0||t<0)?new gr(n):(e<0?n=n.takeRight(-e):e&&(n=n.drop(e)),t!==i&&(n=(t=Bu(t))<0?n.dropRight(-t):n.take(t-e)),n)},gr.prototype.takeRightWhile=function(e){return this.reverse().takeWhile(e).reverse()},gr.prototype.toArray=function(){return this.take(F)},Gr(gr.prototype,function(e,t){var n=/^(?:filter|find|map|reject)|While$/.test(t),r=/^(?:head|last)$/.test(t),o=pr[r?"take"+("last"==t?"Right":""):t],a=r||/^find/.test(t);o&&(pr.prototype[t]=function(){var t=this.__wrapped__,u=r?[1]:arguments,l=t instanceof gr,c=u[0],s=l||gu(t),f=function(e){var t=o.apply(pr,en([e],u));return r&&d?t[0]:t};s&&n&&"function"==typeof c&&1!=c.length&&(l=s=!1);var d=this.__chain__,p=!!this.__actions__.length,h=a&&!d,m=l&&!p;if(!a&&s){t=m?t:new gr(this);var v=e.apply(t,u);return v.__actions__.push({func:Ua,args:[f],thisArg:i}),new vr(v,d)}return h&&m?e.apply(this,u):(v=this.thru(f),h?r?v.value()[0]:v.value():v)})}),Gt(["pop","push","shift","sort","splice","unshift"],function(e){var t=it[e],n=/^(?:push|sort|unshift)$/.test(e)?"tap":"thru",r=/^(?:pop|shift)$/.test(e);pr.prototype[e]=function(){var e=arguments;if(r&&!this.__chain__){var o=this.value();return t.apply(gu(o)?o:[],e)}return this[n](function(n){return t.apply(gu(n)?n:[],e)})}}),Gr(gr.prototype,function(e,t){var n=pr[t];if(n){var r=n.name+"";st.call(or,r)||(or[r]=[]),or[r].push({name:t,func:n})}}),or[hi(i,y).name]=[{name:"wrapper",func:i}],gr.prototype.clone=function(){var e=new gr(this.__wrapped__);return e.__actions__=ri(this.__actions__),e.__dir__=this.__dir__,e.__filtered__=this.__filtered__,e.__iteratees__=ri(this.__iteratees__),e.__takeCount__=this.__takeCount__,e.__views__=ri(this.__views__),e},gr.prototype.reverse=function(){if(this.__filtered__){var e=new gr(this);e.__dir__=-1,e.__filtered__=!0}else(e=this.clone()).__dir__*=-1;return e},gr.prototype.value=function(){var e=this.__wrapped__.value(),t=this.__dir__,n=gu(e),r=t<0,o=n?e.length:0,i=function(e,t,n){for(var r=-1,o=n.length;++r=this.__values__.length;return{done:e,value:e?i:this.__values__[this.__index__++]}},pr.prototype.plant=function(e){for(var t,n=this;n instanceof mr;){var r=da(n);r.__index__=0,r.__values__=i,t?o.__wrapped__=r:t=r;var o=r;n=n.__wrapped__}return o.__wrapped__=e,t},pr.prototype.reverse=function(){var e=this.__wrapped__;if(e instanceof gr){var t=e;return this.__actions__.length&&(t=new gr(this)),(t=t.reverse()).__actions__.push({func:Ua,args:[Ta],thisArg:i}),new vr(t,this.__chain__)}return this.thru(Ta)},pr.prototype.toJSON=pr.prototype.valueOf=pr.prototype.value=function(){return Wo(this.__wrapped__,this.__actions__)},pr.prototype.first=pr.prototype.head,Lt&&(pr.prototype[Lt]=function(){return this}),pr}();Nt._=Mn,(o=function(){return Mn}.call(t,n,t,r))===i||(r.exports=o)}).call(this)}).call(this,n(44),n(45)(e))},function(e,t,n){"use strict"; +/* +object-assign +(c) Sindre Sorhus +@license MIT +*/var r=Object.getOwnPropertySymbols,o=Object.prototype.hasOwnProperty,i=Object.prototype.propertyIsEnumerable;e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map(function(e){return t[e]}).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach(function(e){r[e]=e}),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(e){return!1}}()?Object.assign:function(e,t){for(var n,a,u=function(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}(e),l=1;l0&&o[o.length-1])&&(6===i[0]||2===i[0])){a=0;continue}if(3===i[0]&&(!o||i[1]>o[0]&&i[1]0||window.navigator.msMaxTouchPoints>0),_=g.default(b.Button)(s||(s=o(["\n opacity: ",";\n position: absolute;\n top: 1rem;\n right: 1rem;\n transition: opacity 0.2s;\n :focus {\n opacity: 1;\n }\n"],["\n opacity: ",";\n position: absolute;\n top: 1rem;\n right: 1rem;\n transition: opacity 0.2s;\n :focus {\n opacity: 1;\n }\n"])),w?"1":"0"),k=g.default.div(f||(f=o(["\n position: relative;\n &:hover "," {\n opacity: 1;\n }\n"],["\n position: relative;\n &:hover "," {\n opacity: 1;\n }\n"])),_),x=g.default.div(d||(d=o(["\n font-size: 0.875rem;\n color: ",";\n background-color: ",";\n white-space: ",";\n position: relative;\n\n ","\n"],["\n font-size: 0.875rem;\n color: ",";\n background-color: ",";\n white-space: ",";\n position: relative;\n\n ","\n"])),function(e){return void 0===e.language?y.colors.white:"inherit"},function(e){return e.isLight?"rgba(255,255,255,.15)":void 0===e.language?y.colors.black:"#F1F4F5"},function(e){return void 0===e.language?"nowrap":""},function(e){return e.isDiff?"\n background-color: #E9ECED;\n display: flex;\n padding-top: 1.5rem;\n padding-bottom: 1.5rem;\n overflow-x: auto;\n -webkit-overflow-scrolling: touch;\n ":""}),C=g.default(function(e){e.gutterLength;var t=c(e,["gutterLength"]);return v.createElement("code",a({},t))})(p||(p=o(["\n ::before {\n content: '';\n width: calc(0.75rem + ","ch);\n background-color: #e2e5e6;\n position: absolute;\n top: 0;\n left: 0;\n bottom: 0;\n }\n\n [class^='line-'] {\n display: inline-block;\n width: 100%;\n position: relative;\n padding-right: 1.5rem;\n padding-left: calc(2.25rem + ","ch);\n\n ::before {\n content: attr(data-gutter);\n\n width: ",";\n padding-left: 0.375rem;\n padding-right: 0.375rem;\n position: absolute;\n top: 50%;\n left: 0;\n transform: translateY(-50%);\n z-index: 1;\n }\n }\n\n .line-addition {\n background-color: rgba(0, 202, 105, 0.1);\n }\n .line-deletion {\n background-color: rgba(255, 0, 0, 0.07);\n }\n"],["\n ::before {\n content: '';\n width: calc(0.75rem + ","ch);\n background-color: #e2e5e6;\n position: absolute;\n top: 0;\n left: 0;\n bottom: 0;\n }\n\n [class^='line-'] {\n display: inline-block;\n width: 100%;\n position: relative;\n padding-right: 1.5rem;\n padding-left: calc(2.25rem + ","ch);\n\n ::before {\n content: attr(data-gutter);\n\n width: ",";\n padding-left: 0.375rem;\n padding-right: 0.375rem;\n position: absolute;\n top: 50%;\n left: 0;\n transform: translateY(-50%);\n z-index: 1;\n }\n }\n\n .line-addition {\n background-color: rgba(0, 202, 105, 0.1);\n }\n .line-deletion {\n background-color: rgba(255, 0, 0, 0.07);\n }\n"])),function(e){return e.gutterLength},function(e){return e.gutterLength},function(e){return e.gutterLength}),E=g.default.pre(h||(h=o(["\n margin: 0;\n ",";\n"],["\n margin: 0;\n ",";\n"])),function(e){return e.isDiff?"":"\n padding: 1.5rem;\n overflow-x: auto;\n -webkit-overflow-scrolling: touch;\n "}),S=g.default.textarea(m||(m=o(["\n opacity: 0;\n height: 0;\n position: absolute;\n top: 0;\n right: 0;\n z-index: -1;\n"],["\n opacity: 0;\n height: 0;\n position: absolute;\n top: 0;\n right: 0;\n z-index: -1;\n"]))),T=function(e){function t(){var t=null!==e&&e.apply(this,arguments)||this;return t.state={},t._code=v.createRef(),t}return i(t,e),t.prototype.componentDidMount=function(){this._onMountAsync()},t.prototype.render=function(){var e=this.props,t=e.language,n=e.isLight,r=e.isDiff,o=e.children,i=e.gutterLength,a=e.canCopy,u=this.state.hlCode;return v.createElement(k,null,v.createElement(x,{language:t,isDiff:r,isLight:n},v.createElement(E,{isDiff:r},void 0===u?v.createElement("code",null,o):v.createElement(C,{gutterLength:i,dangerouslySetInnerHTML:u?{__html:this.state.hlCode}:null})),"clipboard"in navigator?null:v.createElement(S,{readOnly:!0,"aria-hidden":"true",ref:this._code,value:o})),a?v.createElement(_,{onClick:this._handleCopyAsync.bind(this)},this.state.didCopy?"Copied":"Copy"):null)},t.prototype._onMountAsync=function(){return u(this,void 0,void 0,function(){var e,t,r,o,i,a,u,c;return l(this,function(l){switch(l.label){case 0:return e=this.props,t=e.language,r=e.children,o=e.isDiff,i=e.gutter,a=e.isEtc,u=r,void 0===t?[3,2]:[4,Promise.all([n.e(10),n.e(6)]).then(n.t.bind(null,67,7))];case 1:c=l.sent().highlight,this.setState({hlCode:c({language:t,code:u,isDiff:o,gutter:i,isEtc:a})}),l.label=2;case 2:return[2]}})})},t.prototype._handleCopyAsync=function(){return u(this,void 0,void 0,function(){var e;return l(this,function(t){switch(t.label){case 0:return t.trys.push([0,4,,5]),"clipboard"in navigator?[4,navigator.clipboard.writeText(this.props.children)]:[3,2];case 1:return t.sent(),this.setState({didCopy:!0}),[3,3];case 2:e=document.activeElement,this._code.current.focus(),this._code.current.select(),document.execCommand("copy"),e.focus(),this.setState({didCopy:!0}),t.label=3;case 3:return[3,5];case 4:return t.sent(),this.setState({didCopy:!1}),[3,5];case 5:return[2]}})})},t}(v.Component);t.Code=T},function(e,t,n){"use strict";var r=this&&this.__makeTemplateObject||function(e,t){return Object.defineProperty?Object.defineProperty(e,"raw",{value:t}):e.raw=t,e},o=this&&this.__assign||function(){return(o=Object.assign||function(e){for(var t,n=1,r=arguments.length;nO.length&&O.push(e)}function A(e,t,n){return null==e?0:function e(t,n,r,o){var u=typeof t;"undefined"!==u&&"boolean"!==u||(t=null);var l=!1;if(null===t)l=!0;else switch(u){case"string":case"number":l=!0;break;case"object":switch(t.$$typeof){case i:case a:l=!0}}if(l)return r(o,t,""===n?"."+I(t,0):n),1;if(l=0,n=""===n?".":n+":",Array.isArray(t))for(var c=0;cthis.eventPool.length&&this.eventPool.push(e)}function pe(e){e.eventPool=[],e.getPooled=fe,e.release=de}o(se.prototype,{preventDefault:function(){this.defaultPrevented=!0;var e=this.nativeEvent;e&&(e.preventDefault?e.preventDefault():"unknown"!=typeof e.returnValue&&(e.returnValue=!1),this.isDefaultPrevented=le)},stopPropagation:function(){var e=this.nativeEvent;e&&(e.stopPropagation?e.stopPropagation():"unknown"!=typeof e.cancelBubble&&(e.cancelBubble=!0),this.isPropagationStopped=le)},persist:function(){this.isPersistent=le},isPersistent:ce,destructor:function(){var e,t=this.constructor.Interface;for(e in t)this[e]=null;this.nativeEvent=this._targetInst=this.dispatchConfig=null,this.isPropagationStopped=this.isDefaultPrevented=ce,this._dispatchInstances=this._dispatchListeners=null}}),se.Interface={type:null,target:null,currentTarget:function(){return null},eventPhase:null,bubbles:null,cancelable:null,timeStamp:function(e){return e.timeStamp||Date.now()},defaultPrevented:null,isTrusted:null},se.extend=function(e){function t(){}function n(){return r.apply(this,arguments)}var r=this;t.prototype=r.prototype;var i=new t;return o(i,n.prototype),n.prototype=i,n.prototype.constructor=n,n.Interface=o({},r.Interface,e),n.extend=r.extend,pe(n),n},pe(se);var he=se.extend({data:null}),me=se.extend({data:null}),ve=[9,13,27,32],ge=G&&"CompositionEvent"in window,ye=null;G&&"documentMode"in document&&(ye=document.documentMode);var be=G&&"TextEvent"in window&&!ye,we=G&&(!ge||ye&&8=ye),_e=String.fromCharCode(32),ke={beforeInput:{phasedRegistrationNames:{bubbled:"onBeforeInput",captured:"onBeforeInputCapture"},dependencies:["compositionend","keypress","textInput","paste"]},compositionEnd:{phasedRegistrationNames:{bubbled:"onCompositionEnd",captured:"onCompositionEndCapture"},dependencies:"blur compositionend keydown keypress keyup mousedown".split(" ")},compositionStart:{phasedRegistrationNames:{bubbled:"onCompositionStart",captured:"onCompositionStartCapture"},dependencies:"blur compositionstart keydown keypress keyup mousedown".split(" ")},compositionUpdate:{phasedRegistrationNames:{bubbled:"onCompositionUpdate",captured:"onCompositionUpdateCapture"},dependencies:"blur compositionupdate keydown keypress keyup mousedown".split(" ")}},xe=!1;function Ce(e,t){switch(e){case"keyup":return-1!==ve.indexOf(t.keyCode);case"keydown":return 229!==t.keyCode;case"keypress":case"mousedown":case"blur":return!0;default:return!1}}function Ee(e){return"object"==typeof(e=e.detail)&&"data"in e?e.data:null}var Se=!1;var Te={eventTypes:ke,extractEvents:function(e,t,n,r){var o=void 0,i=void 0;if(ge)e:{switch(e){case"compositionstart":o=ke.compositionStart;break e;case"compositionend":o=ke.compositionEnd;break e;case"compositionupdate":o=ke.compositionUpdate;break e}o=void 0}else Se?Ce(e,n)&&(o=ke.compositionEnd):"keydown"===e&&229===n.keyCode&&(o=ke.compositionStart);return o?(we&&"ko"!==n.locale&&(Se||o!==ke.compositionStart?o===ke.compositionEnd&&Se&&(i=ue()):(ie="value"in(oe=r)?oe.value:oe.textContent,Se=!0)),o=he.getPooled(o,t,n,r),i?o.data=i:null!==(i=Ee(n))&&(o.data=i),q(o),i=o):i=null,(e=be?function(e,t){switch(e){case"compositionend":return Ee(t);case"keypress":return 32!==t.which?null:(xe=!0,_e);case"textInput":return(e=t.data)===_e&&xe?null:e;default:return null}}(e,n):function(e,t){if(Se)return"compositionend"===e||!ge&&Ce(e,t)?(e=ue(),ae=ie=oe=null,Se=!1,e):null;switch(e){case"paste":return null;case"keypress":if(!(t.ctrlKey||t.altKey||t.metaKey)||t.ctrlKey&&t.altKey){if(t.char&&1